org.jboss.logmanager.ext.formatters

Class StructuredFormatter.Generator

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()

Method Summary

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.
abstract StructuredFormatter.Generator	addStackTrace(Throwable throwable) Writes the stack trace.
StructuredFormatter.Generator	begin() Initial method invoked at the start of the generation.
abstract StructuredFormatter.Generator	end() Writes any trailing data that's needed.

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

addStackTrace

public abstract StructuredFormatter.Generator addStackTrace(Throwable throwable)
                                                     throws Exception

Writes the stack trace.

The implementation is allowed to write the stack trace however is desirable. For example the frames of the stack trace can be broken down into an array or Throwable.printStackTrace() could be used to represent the stack trace.

Parameters:

throwable - the exception to write the stack trace for or null if there is no throwable

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