protected static interface StructuredFormatter.Generator
Modifier and Type | Method | Description |
---|---|---|
default StructuredFormatter.Generator |
add(java.lang.String key,
int value) |
Writes an integer value.
|
default StructuredFormatter.Generator |
add(java.lang.String key,
long value) |
Writes a long value.
|
StructuredFormatter.Generator |
add(java.lang.String key,
java.lang.String value) |
Writes a string value.
|
StructuredFormatter.Generator |
add(java.lang.String key,
java.util.Map<java.lang.String,?> value) |
Writes a map value
|
default StructuredFormatter.Generator |
addAttribute(java.lang.String name,
int value) |
Writes an attribute.
|
default StructuredFormatter.Generator |
addAttribute(java.lang.String name,
java.lang.String value) |
Writes an attribute.
|
default StructuredFormatter.Generator |
addMetaData(java.util.Map<java.lang.String,java.lang.String> metaData) |
Adds the meta data to the structured format.
|
default StructuredFormatter.Generator |
begin() |
Initial method invoked at the start of the generation.
|
StructuredFormatter.Generator |
end() |
Writes any trailing data that's needed.
|
default StructuredFormatter.Generator |
endArray() |
Writes an end for an array.
|
StructuredFormatter.Generator |
endObject() |
Writes an end to the object.
|
default StructuredFormatter.Generator |
startArray(java.lang.String key) |
Writes the start of an array.
|
StructuredFormatter.Generator |
startObject(java.lang.String key) |
Writes the start of an object.
|
default boolean |
wrapArrays() |
Indicates whether or not elements in an array should be wrapped or not.
|
default StructuredFormatter.Generator begin() throws java.lang.Exception
java.lang.Exception
- if an error occurs while adding the datadefault StructuredFormatter.Generator add(java.lang.String key, int value) throws java.lang.Exception
key
- they keyvalue
- the valuejava.lang.Exception
- if an error occurs while adding the datadefault StructuredFormatter.Generator add(java.lang.String key, long value) throws java.lang.Exception
key
- they keyvalue
- the valuejava.lang.Exception
- if an error occurs while adding the dataStructuredFormatter.Generator add(java.lang.String key, java.util.Map<java.lang.String,?> value) throws java.lang.Exception
key
- the key for the mapvalue
- the mapjava.lang.Exception
- if an error occurs while adding the dataStructuredFormatter.Generator add(java.lang.String key, java.lang.String value) throws java.lang.Exception
key
- the key for the valuevalue
- the string valuejava.lang.Exception
- if an error occurs while adding the datadefault StructuredFormatter.Generator addMetaData(java.util.Map<java.lang.String,java.lang.String> metaData) throws java.lang.Exception
By default this processes the map and uses add(String, String)
to add entries.
metaData
- the matp of the meta data, cannot be null
java.lang.Exception
- if an error occurs while adding the dataStructuredFormatter.Generator startObject(java.lang.String key) throws java.lang.Exception
If the wrapArrays()
returns false
the key may be null
and implementations should
handle this.
key
- they key for the object, or null
if this object was
started in an array and the wrapArrays()
is
false
java.lang.Exception
- if an error occurs while adding the dataStructuredFormatter.Generator endObject() throws java.lang.Exception
java.lang.Exception
- if an error occurs while adding the datadefault StructuredFormatter.Generator startArray(java.lang.String key) throws java.lang.Exception
startObject(String)
for convenience of generators
that don't have a specific type for arrays.key
- they key for the arrayjava.lang.Exception
- if an error occurs while adding the datadefault StructuredFormatter.Generator endArray() throws java.lang.Exception
endObject()
for convenience of generators that don't
have a specific type for arrays.java.lang.Exception
- if an error occurs while adding the datadefault StructuredFormatter.Generator addAttribute(java.lang.String name, int value) throws java.lang.Exception
By default this uses the add(String, int)
method to add the attribute. If a formatter requires
special handling for attributes, for example an attribute on an XML element, this method can be overridden.
name
- the name of the attributevalue
- the value of the attributejava.lang.Exception
- if an error occurs while adding the datadefault StructuredFormatter.Generator addAttribute(java.lang.String name, java.lang.String value) throws java.lang.Exception
By default this uses the add(String, String)
method to add the attribute. If a formatter requires
special handling for attributes, for example an attribute on an XML element, this method can be overridden.
name
- the name of the attributevalue
- the value of the attributejava.lang.Exception
- if an error occurs while adding the dataStructuredFormatter.Generator end() throws java.lang.Exception
java.lang.Exception
- if an error occurs while adding the data during the builddefault boolean wrapArrays()
false
.true
if elements should be wrapped, otherwise false
Copyright © 2018. All rights reserved.