com.netflix.nicobar.core.archive

Class ModuleId

java.lang.Object

com.netflix.nicobar.core.archive.ModuleId

public final class ModuleId
extends java.lang.Object

A unique identifier for a script module, composed out of a name and a version identifier.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_VERSION
static java.lang.String	MODULE_VERSION_SEPARATOR

Method Summary

Methods

Modifier and Type	Method and Description
static ModuleId	create(java.lang.String name) Creates a new module identifier using the specified name.
static ModuleId	create(java.lang.String name, java.lang.String version) Creates a new module identifier using the specified name and version.
boolean	equals(java.lang.Object o)
static ModuleId	fromString(java.lang.String moduleId) Parse a module id from a string.
java.lang.String	getName() Get the module name.
java.lang.String	getVersion() Get the module version.
int	hashCode() Determine the hash code of this module identifier.
java.lang.String	toString() Get the string representation of this module identifier.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

public static final java.lang.String DEFAULT_VERSION

See Also:

Constant Field Values

MODULE_VERSION_SEPARATOR

public static final java.lang.String MODULE_VERSION_SEPARATOR

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Get the module name.

Returns:

the module name

getVersion

public java.lang.String getVersion()

Get the module version.

Returns:

the version string

hashCode

public int hashCode()

Determine the hash code of this module identifier.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Get the string representation of this module identifier. If version != DEFAULT_VERSION, this is constructed as "name.version" Else, this is constructed as "name".

Overrides:

toString in class java.lang.Object

Returns:

the string representation

fromString

public static ModuleId fromString(java.lang.String moduleId)
                           throws java.lang.IllegalArgumentException

Parse a module id from a string. If a version identifier cannot be extracted, the version identifier will be set to "" (empty string).

Parameters:

moduleId - the id string

Returns:

the module identifier

Throws:

java.lang.IllegalArgumentException - if the format of the module specification is invalid or it is null

create

public static ModuleId create(java.lang.String name,
              java.lang.String version)

Creates a new module identifier using the specified name and version. An unspecified or empty version ("") can be treated as the canonical, latest version of the module, though the ultimate treatment is upto the integration code using modules.

Parameters:

name - the name of the module

version - the version string

Returns:

the identifier

create

public static ModuleId create(java.lang.String name)

Creates a new module identifier using the specified name.

Parameters:

name - the name of the module

Returns:

the identifier