org.eclipse.equinox.internal.p2.metadata

Class VersionFormat

java.lang.Object

org.eclipse.equinox.internal.p2.metadata.VersionFormat

All Implemented Interfaces:

java.io.Serializable, IVersionFormat

public class VersionFormat
extends java.lang.Object
implements IVersionFormat, java.io.Serializable

The VersionFormat represents the Omni Version Format in compiled form. It is also a parser for versions of that format.

An instance of VersionFormat is immutable and thus thread safe. The parser does not maintain any state.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static VersionFormat	OSGI_FORMAT The predefined OSGi format that is used when parsing OSGi versions.
static java.lang.String	OSGI_FORMAT_STRING The string representation of the Omni Version format used for parsing OSGi versions.
static VersionFormat	RAW_FORMAT The predefined OSGi format that is used when parsing raw versions.
static java.lang.String	RAW_FORMAT_STRING The string representation of the Omni Version format used for parsing raw versions.

Fields inherited from interface org.eclipse.equinox.p2.metadata.IVersionFormat

DEFAULT_MAX_STRING_TRANSLATION, DEFAULT_MIN_STRING_TRANSLATION

Method Summary

Modifier and Type	Method and Description
static IVersionFormat	compile(java.lang.String format) Compile a version format string into a compiled format.
static VersionFormat	compile(java.lang.String format, int start, int end) Compile a version format string into a compiled format.
boolean	equals(java.lang.Object o)
int	hashCode()
Version	parse(java.lang.String version) Parse the given version string.
static BasicVersion	parseRaw(java.lang.String version, IVersionFormat originalFormat, java.lang.String original) Parse a version string using the RAW_FORMAT parser.
java.lang.String	toString() Returns the string representation of this compiled format
void	toString(java.lang.StringBuffer sb) Appends the string representation of this compiled format to the given StringBuffer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OSGI_FORMAT_STRING

public static final java.lang.String OSGI_FORMAT_STRING

The string representation of the Omni Version format used for parsing OSGi versions.

See Also:

Constant Field Values

RAW_FORMAT_STRING

public static final java.lang.String RAW_FORMAT_STRING

The string representation of the Omni Version format used for parsing raw versions.

See Also:

Constant Field Values

OSGI_FORMAT

public static final VersionFormat OSGI_FORMAT

The predefined OSGi format that is used when parsing OSGi versions.

RAW_FORMAT

public static final VersionFormat RAW_FORMAT

The predefined OSGi format that is used when parsing raw versions.

Method Detail

compile

public static IVersionFormat compile(java.lang.String format)
                              throws VersionFormatException

Compile a version format string into a compiled format. This method is shorthand for:

CompiledFormat.compile(format, 0, format.length())

.

Parameters:

format - The format to compile.

Returns:

The compiled format

Throws:

VersionFormatException - If the format could not be compiled

compile

public static VersionFormat compile(java.lang.String format,
                                    int start,
                                    int end)
                             throws VersionFormatException

Compile a version format string into a compiled format. The parsing starts at position start and ends at position end. The returned format is cached so subsequent calls to this method using the same format string will yield the same compiled format instance.

Parameters:

format - The format string to compile.

start - Start position in the format string

end - End position in the format string

Returns:

The compiled format

Throws:

VersionFormatException - If the format could not be compiled

parseRaw

public static BasicVersion parseRaw(java.lang.String version,
                                    IVersionFormat originalFormat,
                                    java.lang.String original)

Parse a version string using the RAW_FORMAT parser.

Parameters:

version - The version to parse.

originalFormat - The original format to assign to the created version. Can be null.

original - The original version string to assign to the created version. Can be null.

Returns:

A created version

Throws:

java.lang.IllegalArgumentException - If the version string could not be parsed.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

parse

public Version parse(java.lang.String version)

Description copied from interface: IVersionFormat

Parse the given version string.

Specified by:

parse in interface IVersionFormat

Parameters:

version - The version string to parse.

Returns:

A created version.

toString

public java.lang.String toString()

Returns the string representation of this compiled format

Overrides:

toString in class java.lang.Object

toString

public void toString(java.lang.StringBuffer sb)

Description copied from interface: IVersionFormat

Appends the string representation of this compiled format to the given StringBuffer.

Specified by:

toString in interface IVersionFormat

Parameters:

sb - The buffer that will receive the string representation