org.xwiki.extension

Class ExtensionId

java.lang.Object

org.xwiki.extension.ExtensionId

All Implemented Interfaces:

Serializable, Comparable<ExtensionId>

public class ExtensionId
extends Object
implements Serializable, Comparable<ExtensionId>

The combination of properties which makes an extension unique.

Since:

4.0M1

Version:

$Id: c9f11414d8c0f6c58eff24c9d569f3b1c47b6ddd $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ParameterizedType	TYPE_LIST Type instance for List<ExtensionId>.

Constructor Summary

Constructors

Constructor and Description
ExtensionId(String id)
ExtensionId(String id, String version)
ExtensionId(String id, Version version)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ExtensionId o)
boolean	equals(Object obj)
String	getId()
Version	getVersion()
int	hashCode()
boolean	matches(ExtensionId extensionId) Same as equals(Object) but with null version meaning "any version".
boolean	matchesOne(Iterable<ExtensionId> extensionIds)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_LIST

public static final ParameterizedType TYPE_LIST

Type instance for List<ExtensionId>.

Since:

8.0M1

Constructor Detail

ExtensionId

public ExtensionId(String id)

Parameters:

id - the extension identifier

Since:

8.0M1, 7.4.6

ExtensionId

public ExtensionId(String id,
                   String version)

Parameters:

id - the extension identifier

version - the extension version

ExtensionId

public ExtensionId(String id,
                   Version version)

Parameters:

id - the extension identifier

version - the extension version

Method Detail

getId

public String getId()

Returns:

the extension identifier

getVersion

public Version getVersion()

Returns:

the extension version

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(ExtensionId o)

Specified by:

compareTo in interface Comparable<ExtensionId>

matches

public boolean matches(ExtensionId extensionId)

Same as equals(Object) but with null version meaning "any version".

Parameters:

extensionId - the extension identifier to match

Returns:

true if the passes extension id matches this extension id

Since:

9.5RC1

matchesOne

public boolean matchesOne(Iterable<ExtensionId> extensionIds)

Parameters:

extensionIds - the extension identifiers to match

Returns:

true if one of the passes extension ids matched this extension id

Since:

9.5RC1