net.sf.mmm.util.version.impl

Class VersionIdentifierFormatterVersionSegments

java.lang.Object

net.sf.mmm.util.lang.base.AbstractFormatter<VersionIdentifier>

net.sf.mmm.util.version.impl.VersionIdentifierFormatterVersionSegments

All Implemented Interfaces:

Formatter<VersionIdentifier>

public class VersionIdentifierFormatterVersionSegments
extends AbstractFormatter<VersionIdentifier>

This is the implementation of Formatter for the plain version number.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private int	maximumSegmentCount The maximum number of segments to format.
private int	minimumSegmentCount The minimum number of segments to format.
private String	prefix The static prefix.
private int	segmentPadding The padding for segments.
private String	segmentSeparator The separator for segments.
private StringUtil	stringUtil The StringUtil instance.

Constructor Summary

Constructors

Constructor and Description
VersionIdentifierFormatterVersionSegments(StringUtil stringUtil, String prefix, String segmentSeparator, int minimumSegmentCount, int maximumSegmentCount, int segmentPadding) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doFormat(VersionIdentifier value, Appendable buffer)
protected CharSequence	doFormatSegment(VersionIdentifier value, int index) This method formats the segment at the given index.

Methods inherited from class net.sf.mmm.util.lang.base.AbstractFormatter

format, format, formatNull

Methods inherited from class java.lang.Object

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

Field Detail

stringUtil

private final StringUtil stringUtil

The StringUtil instance.

prefix

private final String prefix

The static prefix.

segmentSeparator

private final String segmentSeparator

The separator for segments.

minimumSegmentCount

private final int minimumSegmentCount

The minimum number of segments to format.

maximumSegmentCount

private final int maximumSegmentCount

The maximum number of segments to format.

segmentPadding

private final int segmentPadding

The padding for segments.

Constructor Detail

VersionIdentifierFormatterVersionSegments

public VersionIdentifierFormatterVersionSegments(StringUtil stringUtil,
                                                 String prefix,
                                                 String segmentSeparator,
                                                 int minimumSegmentCount,
                                                 int maximumSegmentCount,
                                                 int segmentPadding)

The constructor.

Parameters:

stringUtil - is the StringUtil instance.

prefix - is the static prefix to append before the number. Will be omitted if the number is null.

segmentSeparator - is the separator for segments. The typical value is the dot sign (".").

minimumSegmentCount - is the minimum number of segments to format. The default is 0.

maximumSegmentCount - is maximum number of segments to format. The default is Integer.MAX_VALUE.

segmentPadding - is the padding (minimum number of digits) for each segment. The default is 0.

Method Detail

doFormat

protected void doFormat(VersionIdentifier value,
                        Appendable buffer)
                 throws IOException

Specified by:

doFormat in class AbstractFormatter<VersionIdentifier>

Parameters:

value - is the value to format (not null).

buffer - is the Appendable to append the formatted value to.

Throws:

IOException - if caused by append.

See Also:

AbstractFormatter.format(Object, Appendable)

doFormatSegment

protected CharSequence doFormatSegment(VersionIdentifier value,
                                       int index)

This method formats the segment at the given index.

Parameters:

value - is the VersionIdentifier.

index - is the index of the segment to format.

Returns:

the formatted segment.