Class StringFormatPart
java.lang.Object
org.jboss.logging.processor.validation.AbstractFormatPart
org.jboss.logging.processor.validation.StringFormatPart
- All Implemented Interfaces:
Comparable<FormatPart>
,FormatPart
The parameter part of a format for
Formatter
.
Represents the following format {@linkplain %[argument_index$][flags][width][.precision]conversion}.
Date: 13.06.2011-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The conversions for the string format.static enum
The flags for the string message format. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringFormatPart.Conversion
private Character
private final Set<StringFormatPart.Flag>
private int
private final int
private int
private int
Fields inherited from interface org.jboss.logging.processor.validation.FormatPart
STRING
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
StringFormatPart
(int position) Creates a parameter format part. -
Method Summary
Modifier and TypeMethodDescriptionThe conversion for the string format.char
The date/time conversion character.flags()
A collection of the flags.int
index()
Returns the format parameter index.private void
Initializes the flags based on the string.private void
Initializes the index field based on the string.private void
Initializes the precision based on the string.private void
Initializes the width based on the string.static StringFormatPart
Creates a parameter part of a format string.part()
The part of the format.int
position()
The position for the part.int
The precision for the format.toString()
int
width()
The width for the format.Methods inherited from class org.jboss.logging.processor.validation.AbstractFormatPart
compareTo
-
Field Details
-
index
private int index -
flags
-
width
private int width -
precision
private int precision -
conversion
-
dateTimeConversion
-
position
private final int position
-
-
Constructor Details
-
StringFormatPart
private StringFormatPart(int position) Creates a parameter format part.- Parameters:
position
- the position in the string format.
-
-
Method Details
-
of
Creates a parameter part of a format string.- Parameters:
position
- the position of the part.group
- the group array of the formats (must be a length of 6).- Returns:
- the the parameter part.
- Throws:
IllegalArgumentException
- if the length of the group array is not equal to 6 or a format was invalid.
-
index
public int index()Returns the format parameter index. If the index is inherited,-1
is returned.- Returns:
- the format parameter index.
-
flags
A collection of the flags.- Returns:
- the flags.
-
width
public int width()The width for the format. If the width was not specified,-1
is returned.- Returns:
- the width.
-
precision
public int precision()The precision for the format. If the precision was not specified,-1
is returned.- Returns:
- the precision.
-
conversion
The conversion for the string format.- Returns:
- the conversion.
-
dateTimeChar
public char dateTimeChar()The date/time conversion character.null
if there is not date time conversion character.- Returns:
- the date/time conversion character or
null
.
-
initIndex
Initializes the index field based on the string.- Parameters:
s
- the index in string form.- Throws:
IllegalArgumentException
- if the string is not a number.
-
initFlags
Initializes the flags based on the string. Will set theindex
to-1
if theStringFormatPart.Flag.PREVIOUS
flag is found.- Parameters:
s
- the flags in string form.- Throws:
DuplicateFormatFlagsException
- if the flag is specified more than once.
-
initWidth
Initializes the width based on the string.- Parameters:
s
- the width in string form.- Throws:
IllegalArgumentException
- the string is an invalid number.
-
initPrecision
Initializes the precision based on the string.- Parameters:
s
- the precision in string form.- Throws:
IllegalArgumentException
- if the precision is less than 0 or an invalid number.
-
position
public int position()Description copied from interface:FormatPart
The position for the part.- Returns:
- the position.
-
part
Description copied from interface:FormatPart
The part of the format.- Returns:
- the part of the format.
-
toString
- Overrides:
toString
in classAbstractFormatPart
-