org.eclipse.aether.util.artifact

## Class ArtifactIdUtils

- java.lang.Object
- - org.eclipse.aether.util.artifact.ArtifactIdUtils

-     public final class ArtifactIdUtils
      extends Object

  A utility class to create identifiers for artifacts.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | `equalsBaseId(Artifact artifact1, Artifact artifact2)` Determines whether two artifacts have the same base identifier.
    `static boolean` | `equalsId(Artifact artifact1, Artifact artifact2)` Determines whether two artifacts have the same identifier.
    `static String` | `toBaseId(Artifact artifact)` Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]:<baseVersion>`.
    `static String` | `toId(Artifact artifact)` Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]:<version>`.
    `static String` | `toId(String groupId, String artifactId, String extension, String classifier, String version)` Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]:<version>`.
    `static String` | `toVersionlessId(Artifact artifact)` Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]`.
    `static String` | `toVersionlessId(String groupId, String artifactId, String extension, String classifier)` Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]`.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### toId

          public static String toId(Artifact artifact)

      Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]:<version>`.
      Parameters:
        `artifact` - The artifact to create an identifer for, may be `null`.
      Returns:
        The artifact identifier or `null` if the input was `null`.

    - #### toId

          public static String toId(String groupId,
                    String artifactId,
                    String extension,
                    String classifier,
                    String version)

      Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]:<version>`.
      Parameters:
        `groupId` - The group id, may be `null`.
        `artifactId` - The artifact id, may be `null`.
        `extension` - The file extensiion, may be `null`.
        `classifier` - The classifier, may be `null`.
        `version` - The version, may be `null`.
      Returns:
        The artifact identifier, never `null`.

    - #### toBaseId

          public static String toBaseId(Artifact artifact)

      Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]:<baseVersion>`.
      Parameters:
        `artifact` - The artifact to create an identifer for, may be `null`.
      Returns:
        The artifact identifier or `null` if the input was `null`.

    - #### toVersionlessId

          public static String toVersionlessId(Artifact artifact)

      Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]`.
      Parameters:
        `artifact` - The artifact to create an identifer for, may be `null`.
      Returns:
        The artifact identifier or `null` if the input was `null`.

    - #### toVersionlessId

          public static String toVersionlessId(String groupId,
                               String artifactId,
                               String extension,
                               String classifier)

      Creates an artifact identifier of the form `<groupId>:<artifactId>:<extension>[:<classifier>]`.
      Parameters:
        `groupId` - The group id, may be `null`.
        `artifactId` - The artifact id, may be `null`.
        `extension` - The file extensiion, may be `null`.
        `classifier` - The classifier, may be `null`.
      Returns:
        The artifact identifier, never `null`.

    - #### equalsId

          public static boolean equalsId(Artifact artifact1,
                         Artifact artifact2)

      Determines whether two artifacts have the same identifier. This method is equivalent to calling `String.equals(Object)` on the return values from `toId(Artifact)` for the artifacts but does not incur the overhead of creating temporary strings.
      Parameters:
        `artifact1` - The first artifact, may be `null`.
        `artifact2` - The second artifact, may be `null`.
      Returns:
        `true` if both artifacts are not `null` and have equal ids, `false` otherwise.

    - #### equalsBaseId

          public static boolean equalsBaseId(Artifact artifact1,
                             Artifact artifact2)

      Determines whether two artifacts have the same base identifier. This method is equivalent to calling `String.equals(Object)` on the return values from `toBaseId(Artifact)` for the artifacts but does not incur the overhead of creating temporary strings.
      Parameters:
        `artifact1` - The first artifact, may be `null`.
        `artifact2` - The second artifact, may be `null`.
      Returns:
        `true` if both artifacts are not `null` and have equal base ids, `false` otherwise.

Copyright © 2010-2013 The Eclipse Foundation. All Rights Reserved.