Package org.apache.ivy.core.module.id

Class ModuleRevisionId

java.lang.Object

org.apache.ivy.util.extendable.UnmodifiableExtendableItem

org.apache.ivy.core.module.id.ModuleRevisionId

All Implemented Interfaces:

ExtendableItem

public class ModuleRevisionId
extends UnmodifiableExtendableItem

Identifies a module in a particular version

See Also:

• org.apache.ivy.core.module.id

Field Summary

Fields

Modifier and Type	Field	Description
private final String	branch
private static final Map<ModuleRevisionId,WeakReference<ModuleRevisionId>>	CACHE
private static final String	ENCODE_PREFIX
private static final String	ENCODE_SEPARATOR
private int	hash
private final ModuleId	moduleId
static final Pattern	MRID_PATTERN	Pattern to use to matched mrid text representation.
static final Pattern	NON_CAPTURING_PATTERN	Same as MRID_PATTERN but using non capturing groups, useful to build larger regexp
private static final String	NULL_ENCODE
private static final String	REV_STRICT_CHARS_PATTERN
private final String	revision
(package private) static final String	STRICT_CHARS_PATTERN

Constructor Summary

Constructors

Modifier	Constructor	Description
	ModuleRevisionId(ModuleId moduleId, String revision)
	ModuleRevisionId(ModuleId moduleId, String branch, String revision)
private	ModuleRevisionId(ModuleId moduleId, String branch, String revision, Map<String,String> extraAttributes)
private	ModuleRevisionId(ModuleId moduleId, String branch, String revision, Map<String,String> extraAttributes, boolean replaceNullBranchWithDefault)
private	ModuleRevisionId(ModuleId moduleId, String revision, Map<String,String> extraAttributes)

Method Summary

Modifier and Type	Method	Description
static ModuleRevisionId	decode(String encoded)
String	encodeToString()
boolean	equals(Object obj)
String	getBranch()
ModuleId	getModuleId()
String	getName()
String	getOrganisation()
String	getRevision()
int	hashCode()
static ModuleRevisionId	intern(ModuleRevisionId moduleRevisionId)	Returns an intern instance of the given ModuleRevisionId if any, or put the given ModuleRevisionId in a cache of intern instances and returns it.
static ModuleRevisionId	newInstance(String organisation, String name, String revision)
static ModuleRevisionId	newInstance(String organisation, String name, String branch, String revision)
static ModuleRevisionId	newInstance(String organisation, String name, String branch, String revision, Map<String,String> extraAttributes)
static ModuleRevisionId	newInstance(String organisation, String name, String branch, String revision, Map<String,String> extraAttributes, boolean replaceNullBranchWithDefault)
static ModuleRevisionId	newInstance(String organisation, String name, String revision, Map<String,String> extraAttributes)
static ModuleRevisionId	newInstance(ModuleRevisionId mrid, String rev)
static ModuleRevisionId	newInstance(ModuleRevisionId mrid, String branch, String rev)
private static String	normalizeRevision(String revision)	[revision] is a valid revision in maven.
static ModuleRevisionId	parse(String mrid)	Parses a module revision id text representation and returns a new ModuleRevisionId instance corresponding to the parsed String.
String	toString()

Methods inherited from class org.apache.ivy.util.extendable.UnmodifiableExtendableItem

getAttribute, getAttributes, getExtraAttribute, getExtraAttributes, getQualifiedExtraAttributes, setExtraAttribute, setStandardAttribute

Methods inherited from class java.lang.Object

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

Field Details

ENCODE_SEPARATOR

private static final String ENCODE_SEPARATOR

See Also:

• Constant Field Values

ENCODE_PREFIX

private static final String ENCODE_PREFIX

See Also:

• Constant Field Values

NULL_ENCODE

private static final String NULL_ENCODE

See Also:

• Constant Field Values

STRICT_CHARS_PATTERN

static final String STRICT_CHARS_PATTERN

See Also:

• Constant Field Values

REV_STRICT_CHARS_PATTERN

private static final String REV_STRICT_CHARS_PATTERN

See Also:

• Constant Field Values

CACHE

private static final Map<ModuleRevisionId,WeakReference<ModuleRevisionId>> CACHE

MRID_PATTERN

public static final Pattern MRID_PATTERN

Pattern to use to matched mrid text representation.

See Also:

• parse(String)

NON_CAPTURING_PATTERN

public static final Pattern NON_CAPTURING_PATTERN

Same as MRID_PATTERN but using non capturing groups, useful to build larger regexp

moduleId

private final ModuleId moduleId

branch

private final String branch

revision

private final String revision

hash

private int hash

Constructor Details

ModuleRevisionId

public ModuleRevisionId(ModuleId moduleId,
 String revision)

ModuleRevisionId

public ModuleRevisionId(ModuleId moduleId,
 String branch,
 String revision)

ModuleRevisionId

private ModuleRevisionId(ModuleId moduleId,
 String revision,
 Map<String,String> extraAttributes)

ModuleRevisionId

private ModuleRevisionId(ModuleId moduleId,
 String branch,
 String revision,
 Map<String,String> extraAttributes)

ModuleRevisionId

private ModuleRevisionId(ModuleId moduleId,
 String branch,
 String revision,
 Map<String,String> extraAttributes,
 boolean replaceNullBranchWithDefault)

Method Details

parse

public static ModuleRevisionId parse(String mrid)

Parses a module revision id text representation and returns a new ModuleRevisionId instance corresponding to the parsed String.

The result is unspecified if the module doesn't respect strict name conventions.

Parameters:

mrid - the text representation of the module (as returned by toString()). Must not be null.

Returns:

a ModuleRevisionId corresponding to the given text representation

Throws:

IllegalArgumentException - if the given text representation does not match the ModuleRevisionId text representation rules.

newInstance

public static ModuleRevisionId newInstance(String organisation,
 String name,
 String revision)

newInstance

public static ModuleRevisionId newInstance(String organisation,
 String name,
 String revision,
 Map<String,String> extraAttributes)

newInstance

public static ModuleRevisionId newInstance(String organisation,
 String name,
 String branch,
 String revision)

newInstance

public static ModuleRevisionId newInstance(String organisation,
 String name,
 String branch,
 String revision,
 Map<String,String> extraAttributes)

newInstance

public static ModuleRevisionId newInstance(String organisation,
 String name,
 String branch,
 String revision,
 Map<String,String> extraAttributes,
 boolean replaceNullBranchWithDefault)

newInstance

public static ModuleRevisionId newInstance(ModuleRevisionId mrid,
 String rev)

newInstance

public static ModuleRevisionId newInstance(ModuleRevisionId mrid,
 String branch,
 String rev)

intern

public static ModuleRevisionId intern(ModuleRevisionId moduleRevisionId)

Returns an intern instance of the given ModuleRevisionId if any, or put the given ModuleRevisionId in a cache of intern instances and returns it.

This method should be called on ModuleRevisionId created with one of the constructor to decrease memory footprint.

When using static newInstances methods, this method is already called.

Parameters:

moduleRevisionId - the module revision id to intern

Returns:

an interned ModuleRevisionId

getModuleId

public ModuleId getModuleId()

getName

public String getName()

getOrganisation

public String getOrganisation()

getRevision

public String getRevision()

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

encodeToString

public String encodeToString()

decode

public static ModuleRevisionId decode(String encoded)

getBranch

public String getBranch()

normalizeRevision

private static String normalizeRevision(String revision)

[revision] is a valid revision in maven. This method strips the '[' and ']' characters. Cfr. http://docs.codehaus.org/x/IGU