net.sf.mmm.util.version.impl

Class VersionUtilImpl

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.version.impl.VersionUtilImpl

All Implemented Interfaces:

VersionUtil

@Singleton
 @Named(value="net.sf.mmm.util.version.api.VersionUtil")
public class VersionUtilImpl
extends AbstractLoggableComponent
implements VersionUtil

This is the abstract base-implementation of the VersionUtil interface.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	VersionUtilImpl.FormatPatternStatus This inner class holds the status used to determine if a formatPattern is strict.

Field Summary

Fields

Modifier and Type	Field and Description
private VersionIdentifierFormatter	defaultFormatter
private static CharFilter	INFIX_FILTER A CharFilter that accepts all but ASCII letters.
private static VersionUtil	instance
private Iso8601Util	iso8601Util
private static CharFilter	LETTER_FILTER A CharFilter that accepts all but separators and digits.
private Map<String,DevelopmentPhase>	phaseMap
private Set<String>	phasePrefixSet
private static CharFilter	SEPARATOR_FILTER A CharFilter that accepts common separators.
private StringUtil	stringUtil

Fields inherited from interface net.sf.mmm.util.version.api.VersionUtil

CDI_NAME

Constructor Summary

Constructors

Constructor and Description
VersionUtilImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
protected Map<String,DevelopmentPhase>	createDefaultPhaseMap() This method creates the phase map used as default.
VersionIdentifierFormatter	createFormatter(String formatPattern) Variant of VersionUtil.createFormatter(String, boolean) with strict mode.
VersionIdentifierFormatter	createFormatter(String formatPattern, boolean strict) This method creates a VersionIdentifierFormatter for the given formatPattern.
VersionIdentifier	createVersionIdentifier(String versionString) This method parses the given versionString and builds an according VersionIdentifier instance.
VersionIdentifier	createVersionIdentifier(String versionString, boolean normalizeFormat) This method parses the given versionString and builds an according VersionIdentifier instance.
protected void	doInitialize() This method performs the actual initialization.
VersionIdentifierFormatter	getDefaultFormatter()
static VersionUtil	getInstance() This method gets the singleton instance of this VersionUtilImpl.
protected Iso8601Util	getIso8601Util()
protected Map<String,DevelopmentPhase>	getPhaseMap()
protected Set<String>	getPhasePrefixSet()
protected StringUtil	getStringUtil()
protected Formatter<VersionIdentifier>	parseSubFormatter(CharSequenceScanner scanner, String formatPattern, StringBuilder infixBuffer, VersionUtilImpl.FormatPatternStatus status)
protected void	putPhase(Map<String,DevelopmentPhase> map, String key, DevelopmentPhase phase) This method puts the given phase in the given map using normalized variants of the given key.
void	setDefaultFormatter(VersionIdentifierFormatter defaultFormatter)
void	setIso8601Util(Iso8601Util iso8601Util)
void	setPhaseMap(Map<String,DevelopmentPhase> phaseMappingTable)
void	setPhasePrefixSet(Set<String> phasePrefixSet)
void	setStringUtil(StringUtil stringUtil)

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

INFIX_FILTER

private static final CharFilter INFIX_FILTER

A CharFilter that accepts all but ASCII letters.

SEPARATOR_FILTER

private static final CharFilter SEPARATOR_FILTER

A CharFilter that accepts common separators.

LETTER_FILTER

private static final CharFilter LETTER_FILTER

A CharFilter that accepts all but separators and digits.

instance

private static VersionUtil instance

See Also:

getInstance()

stringUtil

private StringUtil stringUtil

See Also:

getStringUtil()

iso8601Util

private Iso8601Util iso8601Util

See Also:

getIso8601Util()

phaseMap

private Map<String,DevelopmentPhase> phaseMap

See Also:

getPhaseMap()

phasePrefixSet

private Set<String> phasePrefixSet

See Also:

getPhasePrefixSet()

defaultFormatter

private VersionIdentifierFormatter defaultFormatter

See Also:

getDefaultFormatter()

Constructor Detail

VersionUtilImpl

public VersionUtilImpl()

The constructor.

Method Detail

getInstance

public static VersionUtil getInstance()

This method gets the singleton instance of this VersionUtilImpl.
This design is the best compromise between easy access (via this indirection you have direct, static access to all offered functionality) and IoC-style design which allows extension and customization.
For IoC usage, simply ignore all static getInstance() methods and construct new instances via the container-framework of your choice. To wire up the dependent components everything is properly annotated using annotations (JSR-250 and JSR-330). If your container does NOT support this, you should consider using a better one.

Returns:

the singleton instance.

getStringUtil

protected StringUtil getStringUtil()

Returns:

the stringUtil

setStringUtil

@Inject
public void setStringUtil(StringUtil stringUtil)

Parameters:

stringUtil - is the stringUtil to set

getIso8601Util

protected Iso8601Util getIso8601Util()

Returns:

the iso8601Util

setIso8601Util

@Inject
public void setIso8601Util(Iso8601Util iso8601Util)

Parameters:

iso8601Util - is the iso8601Util to set

getPhaseMap

protected Map<String,DevelopmentPhase> getPhaseMap()

Returns:

the phaseMappingTable

getPhasePrefixSet

protected Set<String> getPhasePrefixSet()

Returns:

the Set containing the prefix of the keys before the first hyphen.

setPhasePrefixSet

public void setPhasePrefixSet(Set<String> phasePrefixSet)

Parameters:

phasePrefixSet - is the phasePrefixSet to set

setPhaseMap

public void setPhaseMap(Map<String,DevelopmentPhase> phaseMappingTable)

Parameters:

phaseMappingTable - is the phaseMappingTable to set

getDefaultFormatter

public VersionIdentifierFormatter getDefaultFormatter()

Specified by:

getDefaultFormatter in interface VersionUtil

Returns:

the defaultFormatter

setDefaultFormatter

public void setDefaultFormatter(VersionIdentifierFormatter defaultFormatter)

Parameters:

defaultFormatter - is the defaultFormatter to set

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

putPhase

protected void putPhase(Map<String,DevelopmentPhase> map,
                        String key,
                        DevelopmentPhase phase)

This method puts the given phase in the given map using normalized variants of the given key.

Parameters:

map - is the getPhaseMap().

key - is the key.

phase - is the DevelopmentPhase to put.

createDefaultPhaseMap

protected Map<String,DevelopmentPhase> createDefaultPhaseMap()

This method creates the phase map used as default.

Returns:

the Map.

createVersionIdentifier

public VersionIdentifier createVersionIdentifier(String versionString)
                                          throws NlsParseException

This method parses the given versionString and builds an according VersionIdentifier instance. It delegates to VersionUtil.createFormatter(String, boolean) using false for normalizeFormat.

Specified by:

createVersionIdentifier in interface VersionUtil

Parameters:

versionString - is the string representation of a VersionIdentifier.

Returns:

the parsed VersionIdentifier.

Throws:

NlsParseException - if the given versionString is invalid and could not be parsed.

createVersionIdentifier

public VersionIdentifier createVersionIdentifier(String versionString,
                                                 boolean normalizeFormat)
                                          throws NlsParseException

This method parses the given versionString and builds an according VersionIdentifier instance.

Specified by:

createVersionIdentifier in interface VersionUtil

Parameters:

versionString - is the string representation of a VersionIdentifier.

normalizeFormat - - if true the returned VersionIdentifier will return a normalized string representation that may differ from the given versionString. Otherwise the original versionString will be used.

Returns:

the parsed VersionIdentifier.

Throws:

NlsParseException - if the given versionString is invalid and could not be parsed.

createFormatter

public VersionIdentifierFormatter createFormatter(String formatPattern)

Variant of VersionUtil.createFormatter(String, boolean) with strict mode.

Specified by:

createFormatter in interface VersionUtil

Parameters:

formatPattern - is the format string.

Returns:

the according VersionIdentifierFormatter.

See Also:

VersionUtil.createFormatter(String, boolean)

parseSubFormatter

protected Formatter<VersionIdentifier> parseSubFormatter(CharSequenceScanner scanner,
                                                         String formatPattern,
                                                         StringBuilder infixBuffer,
                                                         VersionUtilImpl.FormatPatternStatus status)

Parameters:

scanner - is the CharSequenceScanner.

formatPattern - is the format pattern.

infixBuffer - is a StringBuilder containing the current infix.

status - is the VersionUtilImpl.FormatPatternStatus.

Returns:

the sub Formatter or null to continue parsing the infix.

See Also:

createFormatter(String, boolean)

createFormatter

public VersionIdentifierFormatter createFormatter(String formatPattern,
                                                  boolean strict)

This method creates a VersionIdentifierFormatter for the given formatPattern. Similar to SimpleDateFormat the format pattern is parsed and there are particular letter symbols that have a specific meaning.

letter	meaning	comment
V	version segments	Needs to be of the form V<separator>[{<min>,<max>,<padding>}] where <separator> is a character used to separate the version segments (typically the dot sign '.'). Further, <min> and <max> are the minimum and maximum number of segments to format and <padding> is the minimum number of digits to pad each segment.
P	phase	The official phase name - typically you want to use "A" instead. May be followed by {<max>} to limit (truncate) to a maximum number of characters.
A	alias	The phase alias. May be followed by {<max>} to limit (truncate) to a maximum number of characters.
N	phase number	The phase number. May be followed by {<padding>} to pad to a minimum number of digits.
S	snapshot indicator	The snapshot indicator. May be followed by {<indicator>} to override the default snapshot indicator with {<indicator>}.
L	label	The label. May be followed by {<max>} to limit (truncate) to a maximum number of characters.
R	revision	The revision. May be followed by {<padding>} to pad to a minimum number of digits.
T	timestamp	The timestamp by default in basic ISO-8601 format. May be followed by {<format>} to use the given format instead as SimpleDateFormat pattern (e.g. "T{yyyy-MM-dd}").

As all ASCII letters are reserved for existing letter symbol definitions (see table above) or further extensions, you need to enclose static text in braces (e.g. "(rev)" to represent the static String "rev" as infix for a format pattern).
Further, infix text (no matter if enclosed in braces or not) is omitted if the following letter symbol is resolved as undefined. To prevent this add the dollar character ($) to terminate a static infix that should always occur.

segment count	major	minor	milli	micro	phase	alias	phase number	snapshot	label	revision	timestamp	formatPattern	format
4	1	2	3	4	null	null	null	false	null	null	null	"V.-AN-S-L-(rev)R-T"	"1.2.3.4-GA"
4	1	2	3	4	"update"	"SR"	2	false	null	654321	null	"V.-AN-S-L-(rev)R-T"	"1.2.3.4-SR2-rev654321"
4	1	2	3	4	"update"	"SR"	2	true	kassiopeia	654321	31.12.1999 23:59:59 UTC	"V.-AN-S-L-(rev)R-T"	"1.2.3.4-SR2-SNAPSHOT-kassiopeia-rev654321-19991231T23:59:59Z"
4	1	2	3	4	"update"	"SR"	2	true	null	654321	31.12.1999 23:59:59 UTC	"V.{0,3,2}P{2}N{2}-S{snap}_$-L-(rev)R-T"	"01.02.03up02-snap_-rev654321-19991231T23:59:59Z"

Specified by:

createFormatter in interface VersionUtil

Parameters:

formatPattern - is the format string.

strict - - if true then the given formatPattern has to include at least the version segments, the phase (in any form including alias), phase number, and snapshot.

Returns:

the according VersionIdentifierFormatter.