# Uses of Interface
org.jboss.logmanager.formatters.FormatStep

Packages that use FormatStep
Package
Description
org.jboss.logmanager.formatters

## Uses of FormatStep in org.jboss.logmanager.formatters

Methods in org.jboss.logmanager.formatters that return FormatStep
Modifier and Type
Method
Description
`static FormatStep`
Formatters.`classNameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth, String precision)`
Create a format step which emits the source class name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`classNameFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth, String precision)`
Create a format step which emits the source class name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`dateFormatStep(String formatString, boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the date of the log record with the given justification rules.
`static FormatStep`
Formatters.`dateFormatStep(TimeZone timeZone, String formatString, boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the date of the log record with the given justification rules.
`static FormatStep`
Formatters.`dateFormatStep(TimeZone timeZone, String formatString, boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the date of the log record with the given justification rules.
`static FormatStep`
Formatters.`exceptionFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth, String argument, boolean extended)`
Create a format step which emits the stack trace of an exception with the given justification rules.
`static FormatStep`
Formatters.`exceptionFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth, boolean extended)`
Create a format step which emits the stack trace of an exception with the given justification rules.
`static FormatStep`
Formatters.`fileNameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the source file name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`fileNameFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the source file name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`formatColor(ColorMap colors, String color)`
`static FormatStep[]`
FormatStringParser.`getSteps(String formatString, ColorMap colors)`
Compile a format string into a series of format steps.
`FormatStep[]`
MultistepFormatter.`getSteps()`
Get a copy of the format steps.
`static FormatStep`
Formatters.`hostnameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth, boolean qualified)`
Create a format step which emits the hostname.
`static FormatStep`
Formatters.`hostnameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth, String precision)`
Create a format step which emits the hostname.
`static FormatStep`
Formatters.`levelFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the log level name.
`static FormatStep`
Formatters.`levelFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the log level name.
`static FormatStep`
Formatters.`lineNumberFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the source file line number with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`lineNumberFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the source file line number with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`lineSeparatorFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the platform line separator.
`static FormatStep`
Formatters.`lineSeparatorFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the platform line separator.
`static FormatStep`
Formatters.`localizedLevelFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the localized log level name.
`static FormatStep`
Formatters.`localizedLevelFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the localized log level name.
`static FormatStep`
Formatters.`locationInformationFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the complete source location information with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`locationInformationFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the complete source location information with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`loggerNameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth, String precision)`
Create a format step which emits the logger name with the given justification rules.
`static FormatStep`
Formatters.`loggerNameFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth, String precision)`
Create a format step which emits the logger name with the given justification rules.
`static FormatStep`
Formatters.`mdcFormatStep(String key, boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the MDC value associated with the given key of the log record.
`static FormatStep`
Formatters.`mdcFormatStep(String key, boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the MDC value associated with the given key of the log record.
`static FormatStep`
Formatters.`messageFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the formatted log message text with the given justification rules.
`static FormatStep`
Formatters.`messageFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the formatted log message text with the given justification rules.
`static FormatStep`
Formatters.`methodNameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the source method name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`methodNameFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the source method name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`moduleNameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth, String precision)`
Create a format step which emits the source module name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`moduleNameFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth, String precision)`
Create a format step which emits the source module name with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`moduleVersionFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth, String precision)`
Create a format step which emits the source module version with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`ndcFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth, int count)`
Create a format step which emits the NDC value of the log record.
`static FormatStep`
Formatters.`ndcFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the NDC value of the log record.
`static FormatStep`
Formatters.`processIdFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the source file line number with the given justification rules (NOTE: call stack introspection introduces a significant performance penalty).
`static FormatStep`
Formatters.`processNameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the source process name with the given justification rules.
`static FormatStep`
Formatters.`relativeTimeFormatStep(long baseTime, boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the number of milliseconds since the given base time.
`static FormatStep`
Formatters.`relativeTimeFormatStep(long baseTime, boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the number of milliseconds since the given base time.
`static FormatStep`
Formatters.`resourceKeyFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the log message resource key (if any) with the given justification rules.
`static FormatStep`
Formatters.`resourceKeyFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the log message resource key (if any) with the given justification rules.
`static FormatStep`
Formatters.`simpleMessageFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the formatted log message text (simple version, no exception traces) with the given justification rules.
`static FormatStep`
Formatters.`simpleMessageFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the formatted log message text (simple version, no exception traces) with the given justification rules.
`static FormatStep`
Formatters.`systemPropertyFormatStep(String argument, boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits a system property value associated with the given key.
`static FormatStep`
Formatters.`textFormatStep(String string)`
Create a format step which simply emits the given string.
`static FormatStep`
Formatters.`threadFormatStep(String argument, boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the id if `id` is passed as the argument, otherwise the the thread name is used.
`static FormatStep`
Formatters.`threadIdFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the id of the thread which originated the log record.
`static FormatStep`
Formatters.`threadNameFormatStep(boolean leftJustify, int minimumWidth, boolean truncateBeginning, int maximumWidth)`
Create a format step which emits the name of the thread which originated the log record.
`static FormatStep`
Formatters.`threadNameFormatStep(boolean leftJustify, int minimumWidth, int maximumWidth)`
Create a format step which emits the name of the thread which originated the log record.
Methods in org.jboss.logmanager.formatters with parameters of type FormatStep
Modifier and Type
Method
Description
`void`
MultistepFormatter.`setSteps(FormatStep[] steps)`
Assign new format steps.
Constructors in org.jboss.logmanager.formatters with parameters of type FormatStep
Modifier
Constructor
Description
``
`MultistepFormatter(FormatStep[] steps)`
Construct a new instance.