net.sf.mmm.util.version.impl

Class AbstractVersionIdentifierFormatterString

java.lang.Object

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

net.sf.mmm.util.version.impl.AbstractVersionIdentifierFormatterString

All Implemented Interfaces:

Formatter<VersionIdentifier>

Direct Known Subclasses:

VersionIdentifierFormatterLabel, VersionIdentifierFormatterPhase, VersionIdentifierFormatterPhaseAlias, VersionIdentifierFormatterPhaseValue, VersionIdentifierFormatterSnapshot, VersionIdentifierFormatterTimestamp

public abstract class AbstractVersionIdentifierFormatterString
extends AbstractFormatter<VersionIdentifier>

This is the abstract base implementation of Formatter for a String -based part of the VersionIdentifier.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

ComposedVersionIdentifierFormatter

Field Summary

Fields

Modifier and Type	Field and Description
private int	maximumLength The maximum number of letters for the String to format.
private String	prefix The static prefix.

Constructor Summary

Constructors

Constructor and Description
AbstractVersionIdentifierFormatterString(String prefix, int maximumLength) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doFormat(VersionIdentifier value, Appendable buffer)
protected abstract String	getString(VersionIdentifier value) This method gets the String to format.

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

prefix

private final String prefix

The static prefix.

maximumLength

private final int maximumLength

The maximum number of letters for the String to format.

Constructor Detail

AbstractVersionIdentifierFormatterString

public AbstractVersionIdentifierFormatterString(String prefix,
                                                int maximumLength)

The constructor.

Parameters:

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

maximumLength - is the maximum number of letters for the String to format. The default is Integer.MAX_VALUE.

Method Detail

getString

protected abstract String getString(VersionIdentifier value)

This method gets the String to format.

Parameters:

value - is the VersionIdentifier.

Returns:

the String to format.

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)