public interface LogFormatter
Modifier and Type | Method and Description |
---|---|
LogFormatter |
add(java.lang.String value)
Add to the log message with just a value.
|
LogFormatter |
add(java.lang.String key,
java.lang.String value)
Add to the log message.
|
void |
addEvent(java.lang.String name,
java.util.Map<java.lang.String,java.lang.String> map)
Adds the event that is to be associated with the log messages onto an
internal stack
|
void |
addEvent(java.lang.String name,
java.lang.String entityName,
java.lang.String entityID)
Adds the event that is to be associated with the log messages onto an
internal stack
|
java.lang.String |
createEntityHierarchyMessage(java.lang.String parentType,
java.lang.String parentID,
java.lang.String childIdType,
java.util.Collection<java.lang.String> childIDs)
Creates a log message that connects the parent entities with the
children.
|
java.lang.String |
createLogMessage()
Creates a log message with the contents of the internal log buffer.
|
java.lang.String |
createLogMessageAndReset()
Creates a log message with the contents of the internal log buffer.
|
java.lang.String |
getEndEventMessage()
Creates the end message for the event on top of the stack.
|
java.lang.String |
getEventName()
Returns the name of event that is currently associated with the log messages
and is on the top of the stack
|
java.lang.String |
getProgramName(java.lang.String name)
Returns the program name for the software whose log statement are logged.
|
java.lang.String |
getStartEventMessage()
Creates the start message for the event on top of the internal stack
|
Event |
popEvent()
Pop the event on top of the internal stack.
|
void |
setProgramName(java.lang.String name)
Sets the program name for the software whose log statement are logged.
|
void setProgramName(java.lang.String name)
name
- java.lang.String getProgramName(java.lang.String name)
name
- void addEvent(java.lang.String name, java.lang.String entityName, java.lang.String entityID)
name
- the name of the event to be associatedentityName
- the primary entity that is associated with the event e.g. workflowentityID
- the id of that entity.void addEvent(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> map)
name
- the name of the event to be associatedmap
- Map indexed by entity name . The values is corresponding
EntityIDEvent popEvent()
java.lang.String getEventName()
java.lang.String getStartEventMessage()
java.lang.String getEndEventMessage()
LogFormatter add(java.lang.String value)
value
- LogFormatter add(java.lang.String key, java.lang.String value)
key
- value
- java.lang.String createLogMessage()
java.lang.String createLogMessageAndReset()
java.lang.String createEntityHierarchyMessage(java.lang.String parentType, java.lang.String parentID, java.lang.String childIdType, java.util.Collection<java.lang.String> childIDs)
parentType
- the type of parent entityparentID
- the id of the parent entitychildIdType
- the type of children entitieschildIDs
- Collection of children id's