org.apache.brooklyn.util.osgi

Class VersionedName

java.lang.Object

org.apache.brooklyn.util.osgi.VersionedName

All Implemented Interfaces:

java.lang.Comparable<VersionedName>

public class VersionedName
extends java.lang.Object
implements java.lang.Comparable<VersionedName>

Records a name (string) and version (string), with conveniences for pretty-printing and converting to OSGi format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionedName.VersionedNameComparator Comparator which puts a:3 < a:1 < b:2 < null
static class	VersionedName.VersionedNameStringComparator Comparator which puts a:3 < a:1 < b:2 < null

Constructor Summary

Constructors

Constructor and Description
VersionedName(org.osgi.framework.Bundle b)
VersionedName(java.lang.String name, java.lang.String v)
VersionedName(java.lang.String name, org.osgi.framework.Version v)

Method Summary

Modifier and Type	Method and Description
int	compareTo(VersionedName other)
boolean	equals(java.lang.Object other)
boolean	equals(java.lang.String sn, java.lang.String v)
boolean	equals(java.lang.String sn, org.osgi.framework.Version v)
boolean	equalsOsgi(java.lang.Object other) As equals(Object) but accepting the argument as equal if versions are identical under the getOsgiVersion() conversion; also accepts strings as the other, converting as per fromString(String)
static VersionedName	fromString(java.lang.String vn) As #parseMaybe(String) but throwing if invalid; allows null version
org.osgi.framework.Version	getOsgiVersion()
java.lang.String	getOsgiVersionString()
java.lang.String	getSymbolicName()
org.osgi.framework.Version	getVersion() Deprecated.
java.lang.String	getVersionString()
int	hashCode()
static Maybe<VersionedName>	parseMaybe(java.lang.String symbolicNameWithVersion, boolean versionRequired) Takes a string which might be of the form "symbolic-name" or "symbolic-name:version" (or something else entirely) and returns a VersionedName.
java.lang.String	toOsgiString()
static VersionedName	toOsgiVersionedName(VersionedName vn) Returns a VersionedName instance where getVersionString() complies with OSGi syntax (or is null), even if the input does not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VersionedName

public VersionedName(org.osgi.framework.Bundle b)

VersionedName

public VersionedName(java.lang.String name,
                     java.lang.String v)

VersionedName

public VersionedName(java.lang.String name,
                     @Nullable
                     org.osgi.framework.Version v)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toOsgiString

public java.lang.String toOsgiString()

equals

public boolean equals(java.lang.String sn,
                      java.lang.String v)

equals

public boolean equals(java.lang.String sn,
                      org.osgi.framework.Version v)

getSymbolicName

public java.lang.String getSymbolicName()

getOsgiVersion

@Nullable
public org.osgi.framework.Version getOsgiVersion()

getOsgiVersionString

@Nullable
public java.lang.String getOsgiVersionString()

getVersionString

@Nullable
public java.lang.String getVersionString()

getVersion

@Deprecated
public org.osgi.framework.Version getVersion()

Deprecated.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

equalsOsgi

public boolean equalsOsgi(java.lang.Object other)

As equals(Object) but accepting the argument as equal if versions are identical under the getOsgiVersion() conversion; also accepts strings as the other, converting as per fromString(String)

toOsgiVersionedName

public static VersionedName toOsgiVersionedName(VersionedName vn)

Returns a VersionedName instance where getVersionString() complies with OSGi syntax (or is null), even if the input does not. Typically used to convert from Brooklyn-recommended 1.0-SNAPSHOT syntax to OSGi-mandated 1.0.0.SNAPSHOT syntax.

fromString

public static VersionedName fromString(java.lang.String vn)

As #parseMaybe(String) but throwing if invalid; allows null version

parseMaybe

public static Maybe<VersionedName> parseMaybe(java.lang.String symbolicNameWithVersion,
                                              boolean versionRequired)

Takes a string which might be of the form "symbolic-name" or "symbolic-name:version" (or something else entirely) and returns a VersionedName. The versionedName.getVersion() will be null if if there was no version in the input and the second argument is false, versions not required. Returns a Maybe.absent() with a suitable message if not valid.

compareTo

public int compareTo(VersionedName other)

Specified by:

compareTo in interface java.lang.Comparable<VersionedName>