org.apache.logging.log4j.core.appender.rolling

Class PatternProcessor

java.lang.Object

org.apache.logging.log4j.core.appender.rolling.PatternProcessor

public class PatternProcessor
extends Object

Parses the rollover pattern.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
PatternProcessor(String pattern) Constructor.
PatternProcessor(String pattern, PatternProcessor copy) Copy constructor with another pattern as source.

Method Summary

Modifier and Type	Method and Description
void	formatFileName(StringBuilder buf, boolean useCurrentTime, Object obj) Format file name.
protected void	formatFileName(StringBuilder buf, Object... objects) Formats file name.
void	formatFileName(StrSubstitutor subst, StringBuilder buf, boolean useCurrentTime, Object obj) Formats file name.
void	formatFileName(StrSubstitutor subst, StringBuilder buf, Object obj) Formats file name.
long	getCurrentFileTime()
FileExtension	getFileExtension()
RolloverFrequency	getFrequency()
long	getNextFileTime()
long	getNextTime(long currentMillis, int increment, boolean modulus) Returns the next potential rollover time.
String	getPattern()
ArrayPatternConverter[]	getPatternConverters()
FormattingInfo[]	getPatternFields()
long	getPrevFileTime()
void	setCurrentFileTime(long currentFileTime)
void	setPrevFileTime(long prevFileTime)
void	setTimeBased(boolean isTimeBased)
String	toString()
void	updateTime()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOGGER

protected static final Logger LOGGER

Constructor Detail

PatternProcessor

public PatternProcessor(String pattern)

Constructor.

Parameters:

pattern - The file pattern.

PatternProcessor

public PatternProcessor(String pattern,
                        PatternProcessor copy)

Copy constructor with another pattern as source.

Parameters:

pattern - The file pattern.

copy - Source pattern processor

Method Detail

getPattern

public String getPattern()

toString

public String toString()

Overrides:

toString in class Object

getPatternFields

public FormattingInfo[] getPatternFields()

getPatternConverters

public ArrayPatternConverter[] getPatternConverters()

setTimeBased

public void setTimeBased(boolean isTimeBased)

getCurrentFileTime

public long getCurrentFileTime()

setCurrentFileTime

public void setCurrentFileTime(long currentFileTime)

getPrevFileTime

public long getPrevFileTime()

setPrevFileTime

public void setPrevFileTime(long prevFileTime)

getFileExtension

public FileExtension getFileExtension()

getNextTime

public long getNextTime(long currentMillis,
                        int increment,
                        boolean modulus)

Returns the next potential rollover time.

Parameters:

currentMillis - The current time.

increment - The increment to the next time.

modulus - If true the time will be rounded to occur on a boundary aligned with the increment.

Returns:

the next potential rollover time and the timestamp for the target file.

updateTime

public void updateTime()

formatFileName

public final void formatFileName(StringBuilder buf,
                                 boolean useCurrentTime,
                                 Object obj)

Format file name.

Parameters:

buf - string buffer to which formatted file name is appended, may not be null.

obj - object to be evaluated in formatting, may not be null.

formatFileName

public final void formatFileName(StrSubstitutor subst,
                                 StringBuilder buf,
                                 Object obj)

Formats file name.

Parameters:

subst - The StrSubstitutor.

buf - string buffer to which formatted file name is appended, may not be null.

obj - object to be evaluated in formatting, may not be null.

formatFileName

public final void formatFileName(StrSubstitutor subst,
                                 StringBuilder buf,
                                 boolean useCurrentTime,
                                 Object obj)

Formats file name.

Parameters:

subst - The StrSubstitutor.

buf - string buffer to which formatted file name is appended, may not be null.

obj - object to be evaluated in formatting, may not be null.

formatFileName

protected final void formatFileName(StringBuilder buf,
                                    Object... objects)

Formats file name.

Parameters:

buf - string buffer to which formatted file name is appended, may not be null.

objects - objects to be evaluated in formatting, may not be null.

getFrequency

public RolloverFrequency getFrequency()

getNextFileTime

public long getNextFileTime()