Package org.jboss.logging.processor.validation

Class StringFormatPart

java.lang.Object

org.jboss.logging.processor.validation.AbstractFormatPart

org.jboss.logging.processor.validation.StringFormatPart

All Implemented Interfaces:

java.lang.Comparable<FormatPart>, FormatPart

class StringFormatPart
extends AbstractFormatPart

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 Classes

Modifier and Type	Class	Description
static class	StringFormatPart.Conversion	The conversions for the string format.
static class	StringFormatPart.Flag	The flags for the string message format.

Field Summary

Fields

Modifier and Type	Field	Description
private StringFormatPart.Conversion	conversion
private java.lang.Character	dateTimeConversion
private java.util.Set<StringFormatPart.Flag>	flags
private int	index
private int	position
private int	precision
private int	width

Fields inherited from interface org.jboss.logging.processor.validation.FormatPart

STRING

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StringFormatPart(int position)	Creates a parameter format part.

Method Summary

Modifier and Type	Method	Description
StringFormatPart.Conversion	conversion()	The conversion for the string format.
char	dateTimeChar()	The date/time conversion character.
java.util.Set<StringFormatPart.Flag>	flags()	A collection of the flags.
int	index()	Returns the format parameter index.
private void	initFlags(java.lang.String s)	Initializes the flags based on the string.
private void	initIndex(java.lang.String s)	Initializes the index field based on the string.
private void	initPrecision(java.lang.String s)	Initializes the precision based on the string.
private void	initWidth(java.lang.String s)	Initializes the width based on the string.
static StringFormatPart	of(int position, java.lang.String[] group)	Creates a parameter part of a format string.
java.lang.String	part()	The part of the format.
int	position()	The position for the part.
int	precision()	The precision for the format.
java.lang.String	toString()
int	width()	The width for the format.

Methods inherited from class org.jboss.logging.processor.validation.AbstractFormatPart

compareTo

Methods inherited from class java.lang.Object

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

Field Detail

index

private int index

flags

private final java.util.Set<StringFormatPart.Flag> flags

width

private int width

precision

private int precision

conversion

private StringFormatPart.Conversion conversion

dateTimeConversion

private java.lang.Character dateTimeConversion

position

private final int position

Constructor Detail

StringFormatPart

private StringFormatPart(int position)

Creates a parameter format part.

Parameters:

position - the position in the string format.

Method Detail

of

public static StringFormatPart of(int position,
                                  java.lang.String[] group)
                           throws java.lang.IllegalArgumentException

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:

java.lang.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

public java.util.Set<StringFormatPart.Flag> 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

public StringFormatPart.Conversion 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

private void initIndex(java.lang.String s)
                throws java.lang.IllegalArgumentException

Initializes the index field based on the string.

Parameters:

s - the index in string form.

Throws:

java.lang.IllegalArgumentException - if the string is not a number.

initFlags

private void initFlags(java.lang.String s)
                throws java.util.DuplicateFormatFlagsException

Initializes the flags based on the string.

Will set the index to -1 if the StringFormatPart.Flag.PREVIOUS flag is found.

Parameters:

s - the flags in string form.

Throws:

java.util.DuplicateFormatFlagsException - if the flag is specified more than once.

initWidth

private void initWidth(java.lang.String s)
                throws java.lang.IllegalArgumentException

Initializes the width based on the string.

Parameters:

s - the width in string form.

Throws:

java.lang.IllegalArgumentException - the string is an invalid number.

initPrecision

private void initPrecision(java.lang.String s)
                    throws java.lang.IllegalArgumentException

Initializes the precision based on the string.

Parameters:

s - the precision in string form.

Throws:

java.lang.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

public java.lang.String part()

Description copied from interface: FormatPart

The part of the format.

Returns:

the part of the format.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractFormatPart