TransformerLog (Alfresco 5.1.4.1 Public Java API)

org.alfresco.repo.content.transform

Class TransformerLog

org.alfresco.repo.content.transform.TransformerLog

All Implemented Interfaces:

org.apache.commons.logging.Log

@org.alfresco.api.AlfrescoPublicApi
public class TransformerLog

implements org.apache.commons.logging.Log

Implementation of a org.apache.commons.logging.Log that logs messages to a structure accessible via TransformerConfigMBean.getTransformationLog(int).

Fields inherited from class org.alfresco.util.LogAdapter

Constructor Summary
TransformerLog()

Method Summary
protected void	addOrModify(Deque<String> entries, Object message) Overridden in sub classes to add a new entry or modify and existing one
void	debug(Object message, Throwable throwable)
String[]	getEntries(int n) Returns the log entries.
String	getPropertyAndValue(Properties defaultProperties) The transformer property and value used to set this logger.
protected String	getPropertyName() Overridden to specify the property name that specifies the maximum number of entries.
protected int	getUpperMaxEntries() Overridden to specify the maximum value the maxEntries property may set.
boolean	isDebugEnabled() Enabled if number of transformer debug entries is greater than 0 AND there is not a test function generating output.
protected void	remove(Deque<String> entries) Removes an entry.
void	setTransformerConfig(TransformerConfig transformerConfig)
void	setTransformerDebug(TransformerDebug transformerDebug)

Methods inherited from class java.lang.Object

public TransformerLog()

protected int getUpperMaxEntries()

Overridden to specify the maximum value the maxEntries property may set. Generally quite a small number as values are stored in memory.

Returns 100 as this is currently held in memory.

protected String getPropertyName()

Overridden to specify the property name that specifies the maximum number of entries.

protected void addOrModify(Deque<String> entries,
Object message)

Overridden in sub classes to add a new entry or modify and existing one

public void setTransformerDebug(TransformerDebug transformerDebug)

setTransformerConfig

public void setTransformerConfig(TransformerConfig transformerConfig)

transformerConfig - used to access the property.

public boolean isDebugEnabled()

Enabled if number of transformer debug entries is greater than 0 AND there is not a test function generating output.

isDebugEnabled in interface org.apache.commons.logging.Log

public void debug(Object message,
Throwable throwable)

debug in interface org.apache.commons.logging.Log

message - to be appended to the log

protected void remove(Deque<String> entries)

Removes an entry. By default removes the first (oldest) entry by may be overridden.

public String[] getEntries(int n)

Returns the log entries.

n - the maximum number of entries to return. All if n is smaller or equal to zero.

public String getPropertyAndValue(Properties defaultProperties)

The transformer property and value used to set this logger. This is commented out if the property has not been overridden (default is 0).

defaultProperties - the transformer.properties file values that may be overridden.

the transformer property and value.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.