Top Description Fields Constructors Methods
ch.qos.logback.core.rolling.helper

public Class FileNamePattern

extends ContextAwareBase
Class Inheritance
Imports
java.time.Instant, java.util.Date, .HashMap, .Map, ch.qos.logback.core.Context, ch.qos.logback.core.pattern.Converter, .ConverterUtil, .LiteralConverter, ch.qos.logback.core.pattern.parser.Node, .Parser, ch.qos.logback.core.spi.ScanException, .ContextAwareBase, ch.qos.logback.core.pattern.util.AlmostAsIsEscapeUtil

After parsing file name patterns, given a number or a date, instances of this class can be used to compute a file name according to the file name pattern and the current date or integer.
Author
Ceki Gülcü

Field Summary

Modifier and TypeField and Description
pack-priv static final Map<String, String>
pack-priv Converter<Object>
pack-priv String
Inherited from ch.qos.logback.core.spi.ContextAwareBase:
context

Constructor Summary

AccessConstructor and Description
public
FileNamePattern(String patternArg, Context contextArg)

Method Summary

Modifier and TypeMethod and Description
public String
public String
convertInt(int i)

public String
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
pack-priv String
public IntegerTokenConverter
public String
public DateTokenConverter<Object>
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
pack-priv void
public void
setPattern(String pattern)

public String
toRegex()

Given date, convert this instance to a regular expression

public String
toRegexForFixedDate(Date
- known date
date
)

Given date, convert this instance to a regular expression.

public String
toRegexForFixedDate(Instant
- known instant
instant
)

Given date, convert this instance to a regular expression.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from ch.qos.logback.core.spi.ContextAwareBase:
addErroraddErroraddInfoaddInfoaddStatusaddWarnaddWarngetContextgetDeclaredOrigingetStatusManagersetContext

Field Detail

CONVERTER_MAPback to summary
pack-priv static final Map<String, String> CONVERTER_MAP
headTokenConverterback to summary
pack-priv Converter<Object> headTokenConverter
patternback to summary
pack-priv String pattern

Constructor Detail

FileNamePatternback to summary
public FileNamePattern(String patternArg, Context contextArg)

Method Detail

convertback to summary
public String convert(Object o)
convertIntback to summary
public String convertInt(int i)
convertMultipleArgumentsback to summary
public String convertMultipleArguments(Object... objectList)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
escapeRightParantesisback to summary
pack-priv String escapeRightParantesis(String in)
getIntegerTokenConverterback to summary
public IntegerTokenConverter getIntegerTokenConverter()
getPatternback to summary
public String getPattern()
getPrimaryDateTokenConverterback to summary
public DateTokenConverter<Object> getPrimaryDateTokenConverter()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
hasIntegerTokenCOnverterback to summary
public boolean hasIntegerTokenCOnverter()
parseback to summary
pack-priv void parse()
setPatternback to summary
public void setPattern(String pattern)
toRegexback to summary
public String toRegex()

Given date, convert this instance to a regular expression

toRegexForFixedDateback to summary
public String toRegexForFixedDate(Date date)

Given date, convert this instance to a regular expression. Used to compute sub-regex when the pattern has both %d and %i, and the date is known.

Parameters
date:Date

- known date

toRegexForFixedDateback to summary
public String toRegexForFixedDate(Instant instant)

Given date, convert this instance to a regular expression. Used to compute sub-regex when the pattern has both %d and %i, and the date is known.

Parameters
instant:Instant

- known instant

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.