Class ModuleId

java.lang.Object
org.apache.ivy.core.module.id.ModuleId
All Implemented Interfaces:
Comparable<ModuleId>
public class ModuleId extends Object implements Comparable<ModuleId>
Identifies a module, without revision information
See Also:

  • Field Details

    • MID_PATTERN

      public static final Pattern MID_PATTERN
      Pattern to use to matched mid text representation.
      See Also:

  • Constructor Details

    • ModuleId

      public ModuleId(String organisation, String name)
      Constructor.
      Parameters:
      organisation - The organisation which creates the module.
      name - The name of the module.

  • Method Details

    • newInstance

      public static ModuleId newInstance(String org, String name)
      Returns a ModuleId for the given organization and module name.
      Parameters:
      org - the module's organization, can be null
      name - the module's name, must not be null
      Returns:
      a ModuleId instance

    • intern

      public static ModuleId intern(ModuleId moduleId)
      Returns an intern instance of a ModuleId equals to the given ModuleId if any, or the given ModuleId.

      This is useful to reduce the number of instances of ModuleId kept in memory, and thus reduce memory footprint.

      Parameters:
      moduleId - the module id to return
      Returns:
      a unit instance of the given module id.

    • getName

      public String getName()
      Returns the name of the module.
      Returns:
      The name of the module.

    • getOrganisation

      public String getOrganisation()
      Returns the name of the organisation.
      Returns:
      The name of the organisation.

    • 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(ModuleId that)
      Specified by:
      compareTo in interface Comparable<ModuleId>

    • encodeToString

      public String encodeToString()
      Returns the encoded String representing this ModuleId.
      Returns:
      The ModuleId encoded as String.

    • getAttributes

      public Map<String,String> getAttributes()
      Returns a Map of all attributes of this module id. The Map keys are attribute names as Strings, and values are corresponding attribute values (as String too).
      Returns:
      A Map instance containing all the attributes and their values.

    • decode

      public static ModuleId decode(String encoded)
      Returns a ModuleId
      Parameters:
      encoded - String
      Returns:
      The new ModuleId.
      Throws:
      IllegalArgumentException - If the given String could not be decoded.

    • parse

      public static ModuleId parse(String mid)
      Parses the module id text representation and returns it as a ModuleId instance.
      Parameters:
      mid - the module id text representation to parse
      Returns:
      the ModuleId instance corresponding to the representation
      Throws:
      IllegalArgumentException - if the given text representation cannot be parsed