|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.api.utils.text.JsonWriter
public class JsonWriter
Writes JSON as a stream. This class allows plugins to not directly depend on the underlying JSON library.
StringWriter json = new StringWriter(); JsonWriter writer = JsonWriter.of(json); writer .beginObject() .prop("aBoolean", true) .prop("aInt", 123) .prop("aString", "foo") .beginObject().name("aList") .beginArray() .beginObject().prop("key", "ABC").endObject() .beginObject().prop("key", "DEF").endObject() .endArray() .endObject() .close();
Method Summary | |
---|---|
JsonWriter |
beginArray()
Begins encoding a new array. |
JsonWriter |
beginObject()
Begins encoding a new object. |
void |
close()
|
JsonWriter |
endArray()
Ends encoding the current array. |
JsonWriter |
endObject()
Ends encoding the current object. |
JsonWriter |
name(String name)
Encodes the property name. |
static JsonWriter |
of(Writer writer)
|
JsonWriter |
prop(String name,
boolean value)
|
JsonWriter |
prop(String name,
double value)
|
JsonWriter |
prop(String name,
long value)
|
JsonWriter |
prop(String name,
Number value)
Encodes the property name and value. |
JsonWriter |
prop(String name,
String value)
|
JsonWriter |
propDate(String name,
Date value)
Encodes the property name and date value (ISO format). |
JsonWriter |
propDateTime(String name,
Date value)
Encodes the property name and datetime value (ISO format). |
JsonWriter |
value(boolean value)
Encodes value . |
JsonWriter |
value(double value)
|
JsonWriter |
value(long value)
|
JsonWriter |
value(Number value)
|
JsonWriter |
value(String value)
|
JsonWriter |
valueDate(Date value)
|
JsonWriter |
valueDateTime(Date value)
|
JsonWriter |
valueObject(Object value)
Encodes an object that can be a : primitive types: String, Number, Boolean java.util.Date: encoded as datetime (see valueDateTime(java.util.Date)
Map . |
JsonWriter |
values(Iterable<String> values)
Write a list of values in an array, for example: |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static JsonWriter of(Writer writer)
public JsonWriter beginArray()
endArray()
. Output is [
.
WriterException
- on any failurepublic JsonWriter endArray()
]
.
WriterException
- on any failurepublic JsonWriter beginObject()
endObject()
. Output is {
.
WriterException
- on any failurepublic JsonWriter endObject()
}
.
WriterException
- on any failurepublic JsonWriter name(String name)
"theName":
.
WriterException
- on any failurepublic JsonWriter value(boolean value)
value
. Output is true
or false
.
WriterException
- on any failurepublic JsonWriter value(double value)
WriterException
- on any failurepublic JsonWriter value(@Nullable String value)
WriterException
- on any failurepublic JsonWriter valueObject(@Nullable Object value)
valueDateTime(java.util.Date)
Map
. Method toString is called for the key.
WriterException
- on any failurepublic JsonWriter values(Iterable<String> values)
writer.beginArray().values(myValues).endArray();
WriterException
- on any failurepublic JsonWriter valueDate(@Nullable Date value)
WriterException
- on any failurepublic JsonWriter valueDateTime(@Nullable Date value)
public JsonWriter value(long value)
WriterException
- on any failurepublic JsonWriter value(@Nullable Number value)
WriterException
- on any failurepublic JsonWriter prop(String name, @Nullable Number value)
"theName":123
.
WriterException
- on any failurepublic JsonWriter propDate(String name, @Nullable Date value)
"theDate":"2013-01-24"
.
WriterException
- on any failurepublic JsonWriter propDateTime(String name, @Nullable Date value)
"theDate":"2013-01-24T13:12:45+01"
.
WriterException
- on any failurepublic JsonWriter prop(String name, @Nullable String value)
WriterException
- on any failurepublic JsonWriter prop(String name, boolean value)
WriterException
- on any failurepublic JsonWriter prop(String name, long value)
WriterException
- on any failurepublic JsonWriter prop(String name, double value)
WriterException
- on any failurepublic void close()
WriterException
- on any failure
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |