All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractStructuredStringWriter, AbstractStructuredWriter
```
public interface StructuredWriter
extends AutoCloseable
```
Interface for a writer to produce a structured format such as JSON or XML.

Since:

1.0.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`close()`
`void`	`writeEnd()`	Writes the end of an `array` or `object`.
`void`	`writeName(String name)`	Writes the name of a property.
`void`	`writeStartArray()`	Writes the start of an array or collection.
`void`	`writeStartObject()`	Writes the start of an object.
`default void`	`writeValue(Object value)`	Writes a value for the current property or `array` element. ATTENTION: This generic method only exists as convenience method for the `writeValueAs*` methods.
`default void`	`writeValueAsBigDecimal(BigDecimal value)`
`default void`	`writeValueAsBigInteger(BigInteger value)`
`void`	`writeValueAsBoolean(Boolean value)`
`default void`	`writeValueAsByte(Byte value)`
`default void`	`writeValueAsDouble(Double value)`
`default void`	`writeValueAsFloat(Float value)`
`default void`	`writeValueAsInteger(Integer value)`
`default void`	`writeValueAsLong(Long value)`
`void`	`writeValueAsNull()`	Writes the value `null` (undefined).
`default void`	`writeValueAsNumber(Number value)`	Writes a `Number` value for the current property or `array` element.
`default void`	`writeValueAsShort(Short value)`
`void`	`writeValueAsString(String value)`

- Method Detail
  - writeStartArray
```
void writeStartArray()
```
    Writes the start of an array or collection. After the call of this method for each element of the array or collection a call of writeValue(Object) (including any of its typed variants) needs to be called followed by writeEnd().
  - writeStartObject
```
void writeStartObject()
```
    Writes the start of an object. After the call of this method for each property of the object writeName(String) needs to be called followed by writing its value. Then writeEnd() needs to be called to terminate the object.
  - writeEnd
```
void writeEnd()
```
    Writes the end of an array or object.
  - writeName
```
void writeName(String name)
```
    Writes the name of a property. After the call of this method a subsequent call of writeStartArray(), writeStartObject() or writeValue(Object) (including any of its typed variants) needs to be called.
    
    Parameters:
    
    name -
  - writeValue
```
default void writeValue(Object value)
```
    Writes a value for the current property or array element.
    ATTENTION:
    This generic method only exists as convenience method for the writeValueAs* methods. It therefore only supports standard Java value types as described in io.github.mmm.marshall. For other types it falls back to Object.toString().
    
    Parameters:
    
    value - the value to write. May be null.
  - writeValueAsNumber
```
default void writeValueAsNumber(Number value)
```
    Writes a Number value for the current property or array element.
    
    Parameters:
    
    value - the value to write. May be null.
  - writeValueAsNull
```
void writeValueAsNull()
```
    Writes the value null (undefined). Called from all other writeValue* methods in case null is provided as value. Via MarshallingConfig.WRITE_NULL_VALUES one can configure if null values should be written or omitted (to save bandwidth).
    
    See Also:
    
    writeValue(Object)
  - writeValueAsString
```
void writeValueAsString(String value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsBoolean
```
void writeValueAsBoolean(Boolean value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsBigDecimal
```
default void writeValueAsBigDecimal(BigDecimal value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsBigInteger
```
default void writeValueAsBigInteger(BigInteger value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsLong
```
default void writeValueAsLong(Long value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsInteger
```
default void writeValueAsInteger(Integer value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsShort
```
default void writeValueAsShort(Short value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsByte
```
default void writeValueAsByte(Byte value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsDouble
```
default void writeValueAsDouble(Double value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - writeValueAsFloat
```
default void writeValueAsFloat(Float value)
```
    Parameters:
    
    value - the value to write.
    
    See Also:
    
    writeValue(Object)
  - close
```
void close()
```
    Specified by:
    
    close in interface AutoCloseable

Interface StructuredWriter

Method Summary

Method Detail

writeStartArray

writeStartObject

writeEnd

writeName

writeValue

writeValueAsNumber

writeValueAsNull

writeValueAsString

writeValueAsBoolean

writeValueAsBigDecimal

writeValueAsBigInteger

writeValueAsLong

writeValueAsInteger

writeValueAsShort

writeValueAsByte

writeValueAsDouble

writeValueAsFloat

close