aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api/src/main/java/org
diff options
context:
space:
mode:
authorSimon Brandhof <simon.brandhof@gmail.com>2012-08-16 18:16:43 +0200
committerSimon Brandhof <simon.brandhof@gmail.com>2012-08-16 18:16:43 +0200
commit6c8a4634f28f50fbcebcc557316f6a24130527ee (patch)
tree4b7527a70568ed170b31575ea12808a04b163bbb /sonar-plugin-api/src/main/java/org
parent332666da7de5be6fa5dea0e0ee418f98de796c59 (diff)
downloadsonarqube-6c8a4634f28f50fbcebcc557316f6a24130527ee.tar.gz
sonarqube-6c8a4634f28f50fbcebcc557316f6a24130527ee.zip
Add tip for parsing KeyValueFormat format from ruby code
Diffstat (limited to 'sonar-plugin-api/src/main/java/org')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java6
1 files changed, 4 insertions, 2 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java b/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java
index 6f004c963ba..0f6ebd7103c 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/utils/KeyValueFormat.java
@@ -34,8 +34,10 @@ import java.text.SimpleDateFormat;
import java.util.*;
/**
- * Formats and parses key/value pairs with the string representation : "key1=value1;key2=value2". Conversion
- * of fields is supported and can be extended.
+ * <p>Formats and parses key/value pairs with the string representation : "key1=value1;key2=value2". Conversion
+ * of fields is supported and can be extended.</p>
+ *
+ * <p>This format can easily be parsed with Ruby code: <code>hash=Hash[*(my_string.split(';').map { |elt| elt.split('=') }.flatten)]</code></p>
*
* @since 1.10
*/