StructuredFormatter.Generator (JBoss Log Manager Extension 1.0.0.Alpha4 API)

java.lang.Object
- org.jboss.logmanager.ext.formatters.StructuredFormatter.Generator

Enclosing class:

StructuredFormatter
```
protected abstract static class StructuredFormatter.Generator
extends Object
```
A generator used to create the structured output.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Generator()

Constructors
Modifier	Constructor and Description
`protected`	`Generator()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`StructuredFormatter.Generator`	`add(String key, int value)` Writes an integer value.
`StructuredFormatter.Generator`	`add(String key, long value)` Writes a long value.
`abstract StructuredFormatter.Generator`	`add(String key, Map<String,?> value)` Writes a map value
`abstract StructuredFormatter.Generator`	`add(String key, String value)` Writes a string value.
`StructuredFormatter.Generator`	`addAttribute(String name, int value)` Writes an attribute.
`StructuredFormatter.Generator`	`addAttribute(String name, String value)` Writes an attribute.
`StructuredFormatter.Generator`	`addMetaData(Map<String,String> metaData)` Adds the meta data to the structured format.
`StructuredFormatter.Generator`	`begin()` Initial method invoked at the start of the generation.
`abstract StructuredFormatter.Generator`	`end()` Writes any trailing data that's needed.
`StructuredFormatter.Generator`	`endArray()` Writes an end for an array.
`abstract StructuredFormatter.Generator`	`endObject()` Writes an end to the object.
`StructuredFormatter.Generator`	`startArray(String key)` Writes the start of an array.
`abstract StructuredFormatter.Generator`	`startObject(String key)` Writes the start of an object.
`boolean`	`wrapArrays()` Indicates whether or not elements in an array should be wrapped or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Generator
```
protected Generator()
```
- Method Detail
  - begin
```
public StructuredFormatter.Generator begin()
                                    throws Exception
```
    Initial method invoked at the start of the generation.
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - add
```
public StructuredFormatter.Generator add(String key,
                                         int value)
                                  throws Exception
```
    Writes an integer value.
    
    Parameters:
    
    key - they key
    
    value - the value
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - add
```
public StructuredFormatter.Generator add(String key,
                                         long value)
                                  throws Exception
```
    Writes a long value.
    
    Parameters:
    
    key - they key
    
    value - the value
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - add
```
public abstract StructuredFormatter.Generator add(String key,
                                                  Map<String,?> value)
                                           throws Exception
```
    Writes a map value
    
    Parameters:
    
    key - the key for the map
    
    value - the map
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - add
```
public abstract StructuredFormatter.Generator add(String key,
                                                  String value)
                                           throws Exception
```
    Writes a string value.
    
    Parameters:
    
    key - the key for the value
    
    value - the string value
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - addMetaData
```
public StructuredFormatter.Generator addMetaData(Map<String,String> metaData)
                                          throws Exception
```
    Adds the meta data to the structured format.
    By default this processes the map and uses add(String, String) to add entries.
    
    Parameters:
    
    metaData - the matp of the meta data, cannot be null
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - startObject
```
public abstract StructuredFormatter.Generator startObject(String key)
                                                   throws Exception
```
    Writes the start of an object.
    If the wrapArrays() returns false the key may be null and implementations should handle this.
    
    Parameters:
    
    key - they key for the object, or null if this object was started in an array and the wrapArrays() is false
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - endObject
```
public abstract StructuredFormatter.Generator endObject()
                                                 throws Exception
```
    Writes an end to the object.
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - startArray
```
public StructuredFormatter.Generator startArray(String key)
                                         throws Exception
```
    Writes the start of an array. This defaults to startObject(String) for convenience of generators that don't have a specific type for arrays.
    
    Parameters:
    
    key - they key for the array
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - endArray
```
public StructuredFormatter.Generator endArray()
                                       throws Exception
```
    Writes an end for an array. This defaults to endObject() for convenience of generators that don't have a specific type for arrays.
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - addAttribute
```
public StructuredFormatter.Generator addAttribute(String name,
                                                  int value)
                                           throws Exception
```
    Writes an attribute.
    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.
    
    Parameters:
    
    name - the name of the attribute
    
    value - the value of the attribute
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - addAttribute
```
public StructuredFormatter.Generator addAttribute(String name,
                                                  String value)
                                           throws Exception
```
    Writes an attribute.
    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.
    
    Parameters:
    
    name - the name of the attribute
    
    value - the value of the attribute
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data
  - end
```
public abstract StructuredFormatter.Generator end()
                                           throws Exception
```
    Writes any trailing data that's needed.
    
    Returns:
    
    the generator
    
    Throws:
    
    Exception - if an error occurs while adding the data during the build
  - wrapArrays
```
public boolean wrapArrays()
```
    Indicates whether or not elements in an array should be wrapped or not. The default is false.
    
    Returns:
    
    true if elements should be wrapped, otherwise false

Class StructuredFormatter.Generator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Generator

Method Detail

begin

add

add

add

add

addMetaData

startObject

endObject

startArray

endArray

addAttribute

addAttribute

end

wrapArrays