org.apache.ivy.core.module.id

Class ModuleRevisionId

public class ModuleRevisionId extends UnmodifiableExtendableItem

Identifies a module in a particular version

See Also: org.apache.ivy.core.module.id

Field Summary
static PatternMRID_PATTERN
Pattern to use to matched mrid text representation.
static PatternNON_CAPTURING_PATTERN
Same as MRID_PATTERN but using non capturing groups, useful to build larger regexp
Constructor Summary
ModuleRevisionId(ModuleId moduleId, String revision)
ModuleRevisionId(ModuleId moduleId, String branch, String revision)
Method Summary
static ModuleRevisionIddecode(String encoded)
StringencodeToString()
booleanequals(Object obj)
StringgetBranch()
ModuleIdgetModuleId()
StringgetName()
StringgetOrganisation()
StringgetRevision()
inthashCode()
static ModuleRevisionIdintern(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 ModuleRevisionIdnewInstance(String organisation, String name, String revision)
static ModuleRevisionIdnewInstance(String organisation, String name, String revision, Map extraAttributes)
static ModuleRevisionIdnewInstance(String organisation, String name, String branch, String revision)
static ModuleRevisionIdnewInstance(String organisation, String name, String branch, String revision, Map extraAttributes)
static ModuleRevisionIdnewInstance(String organisation, String name, String branch, String revision, Map extraAttributes, boolean replaceNullBranchWithDefault)
static ModuleRevisionIdnewInstance(ModuleRevisionId mrid, String rev)
static ModuleRevisionIdnewInstance(ModuleRevisionId mrid, String branch, String rev)
static ModuleRevisionIdparse(String mrid)
Parses a module revision id text representation and returns a new ModuleRevisionId instance corresponding to the parsed String.
StringtoString()

Field Detail

MRID_PATTERN

public static final Pattern MRID_PATTERN
Pattern to use to matched mrid text representation.

See Also: parse

NON_CAPTURING_PATTERN

public static final Pattern NON_CAPTURING_PATTERN
Same as MRID_PATTERN but using non capturing groups, useful to build larger regexp

Constructor Detail

ModuleRevisionId

public ModuleRevisionId(ModuleId moduleId, String revision)

ModuleRevisionId

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

Method Detail

decode

public static ModuleRevisionId decode(String encoded)

encodeToString

public String encodeToString()

equals

public boolean equals(Object obj)

getBranch

public String getBranch()

getModuleId

public ModuleId getModuleId()

getName

public String getName()

getOrganisation

public String getOrganisation()

getRevision

public String getRevision()

hashCode

public int hashCode()

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

newInstance

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

newInstance

public static ModuleRevisionId newInstance(String organisation, String name, String revision, Map 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 extraAttributes)

newInstance

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

newInstance

public static ModuleRevisionId newInstance(ModuleRevisionId mrid, String rev)

newInstance

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

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.

toString

public String toString()