/*

  * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH

  *

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  *     http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package de.smartics.properties.resource.repository;

 import java.io.Serializable;

 import javax.annotation.concurrent.ThreadSafe;

 import org.apache.commons.lang.ObjectUtils;

 import de.smartics.util.lang.Arguments;

 /**

  * Identifies an artifact of resources.

  */

 @ThreadSafe

 public final class ArtifactId implements Serializable, Comparable<ArtifactId>

 { // NOPMD

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   /**

    * The class version identifier.

    */

   private static final long serialVersionUID = 1L;

   // --- members --------------------------------------------------------------

   /**

    * The group the artifact belongs to.

    *

    * @serial

    */

   private final String groupId;

   /**

    * The name of the artifact.

    *

    * @serial

    */

   private final String name;

   /**

    * The version of the artifact.

    *

    * @serial

    */

   private final String version;

   /**

    * The artifact type that is expressed by the artifact's file name extension.

    *

    * @serial

    */

   private final String archiveType;

   /**

    * The classifier to the artifact. May be <code>null</code>.

    *

    * @serial

    */

   private final String classifier;

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   private ArtifactId(final Builder builder)

   {

     this.groupId = builder.groupId;

     this.name = builder.name;

     this.version = builder.version;

     this.archiveType = builder.archiveType;

     this.classifier = builder.classifier;

   }

   // ****************************** Inner Classes *****************************

   /**

    * Builder to create instances of {@link ArtifactId}.

    */

   public static final class Builder

   {

     // ******************************** Fields ********************************

     // --- constants ----------------------------------------------------------

     // --- members ------------------------------------------------------------

     /**

      * The group the artifact belongs to.

      */

     private String groupId;

     /**

      * The name of the artifact.

      */

     private String name;

     /**

      * The version of the artifact.

      */

     private String version;

     /**

      * The artifact type that is expressed by the artifact's file name

      * extension.

      */

     private String archiveType;

     /**

      * The classifier to the artifact. May be <code>null</code>.

      */

     private String classifier;

     // ***************************** Initializer ******************************

     // ***************************** Constructors *****************************

     // ***************************** Inner Classes ****************************

     // ******************************** Methods *******************************

     // --- init ---------------------------------------------------------------

     // --- get&set ------------------------------------------------------------

     /**

      * Sets the group the artifact belongs to.

      *

      * @param groupId the group the artifact belongs to.

      * @return a reference to this builder instance.

      * @throws IllegalArgumentException if {@code groupId} is blank.

      */

     public Builder withGroupId(final String groupId)

       throws IllegalArgumentException

     {

       Arguments.checkNotBlank("groupId", groupId);

       this.groupId = groupId;

       return this;

     }

     /**

      * Sets the name of the artifact.

      *

      * @param name the name of the artifact.

      * @return a reference to this builder instance.

      * @throws IllegalArgumentException if {@code name} is blank.

      */

     public Builder withName(final String name) throws IllegalArgumentException

     {

       Arguments.checkNotBlank("name", name);

       this.name = name;

       return this;

     }

     /**

      * Sets the version of the artifact.

      *

      * @param version the version of the artifact.

      * @return a reference to this builder instance.

      * @throws IllegalArgumentException if {@code version} is blank.

      */

     public Builder withVersion(final String version)

       throws IllegalArgumentException

     {

       Arguments.checkNotBlank("version", version);

       this.version = version;

       return this;

     }

     /**

      * Sets the artifact type that is expressed by the artifact's file name

      * extension.

      *

      * @param archiveType the artifact type that is expressed by the artifact's

      *          file name extension.

      * @return a reference to this builder instance.

      * @throws IllegalArgumentException if {@code archiveType} is blank.

      */

     public Builder withArchiveType(final String archiveType)

       throws IllegalArgumentException

     {

       Arguments.checkNotBlank("archiveType", archiveType);

       this.archiveType = archiveType;

       return this;

     }

     /**

      * Sets the classifier to the artifact.

      *

      * @param classifier the classifier to the artifact. May be

      *          <code>null</code>.

      * @return a reference to this builder instance.

      * @throws IllegalArgumentException if classifier is blank except

      *           <code>null</code>.

      */

     public Builder withClassifier(final String classifier)

       throws IllegalArgumentException

     {

       Arguments.checkNotBlankExceptNull("classifier", classifier);

       this.classifier = classifier;

       return this;

     }

     // --- business -----------------------------------------------------------

     /**

      * Creates an instance of {@link ArtifactId}.

      *

      * @return an instance.

      */

     public ArtifactId build()

     {

       Arguments.checkNotBlank("groupId", groupId);

       Arguments.checkNotBlank("name", name);

       Arguments.checkNotBlank("version", version);

       Arguments.checkNotBlank("archiveType", archiveType);

       Arguments.checkNotBlankExceptNull("classifier", classifier);

       final ArtifactId instance = new ArtifactId(this);

       return instance;

     }

     // --- object basics ------------------------------------------------------

   }

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   // --- factory --------------------------------------------------------------

   /**

    * Helper to create instances of {@link ArtifactId} instead of using the

    * {@link ArtifactId.Builder}.

    *

    * @param groupId the group the artifact belongs to.

    * @param name the identifier of the artifact.

    * @param version the version of the artifact.

    * @param archiveType the artifact type that is expressed by the artifact's

    *          file name extension.

    * @param classifier the classifier to the artifact.

    * @return the instance.

    * @throws IllegalArgumentException if any of the arguments (except

    *           {@code classifier}) is blank or {@code classifier} is blank

    *           except being <code>null</code>.

    */

   public static ArtifactId create(final String groupId, final String name,

       final String version, final String archiveType, final String classifier)

     throws IllegalArgumentException

   {

     final Builder builder = new Builder();

     builder.withGroupId(groupId).withName(name).withVersion(version)

         .withArchiveType(archiveType).withClassifier(classifier);

     return builder.build();

   }

   // --- get&set --------------------------------------------------------------

   /**

    * Returns the group the artifact belongs to.

    *

    * @return the group the artifact belongs to.

    */

   public String getGroupId()

   {

     return groupId;

   }

   /**

    * Returns the name of the artifact.

    *

    * @return the name of the artifact.

    */

   public String getName()

   {

     return name;

   }

   /**

    * Returns the version of the artifact.

    *

    * @return the version of the artifact.

    */

   public String getVersion()

   {

     return version;

   }

   /**

    * Returns the artifact type that is expressed by the artifact's file name

    * extension.

    *

    * @return the artifact type that is expressed by the artifact's file name

    *         extension.

    */

   public String getArchiveType()

   {

     return archiveType;

   }

   /**

    * Returns the classifier to the artifact. May be <code>null</code>.

    *

    * @return the classifier to the artifact.

    */

   public String getClassifier()

   {

     return classifier;

   }

   // --- business -------------------------------------------------------------

   // --- object basics --------------------------------------------------------

   /**

    * Returns the hash code of the object.

    *

    * @return the hash code.

    */

   @Override

   public int hashCode()

   {

     int result = 17;

     result = 37 * result + ObjectUtils.hashCode(name);

     result = 37 * result + ObjectUtils.hashCode(groupId);

     result = 37 * result + ObjectUtils.hashCode(version);

     return result;

   }

   /**

    * Returns <code>true</code> if the given object is semantically equal to the

    * given object, <code>false</code> otherwise.

    *

    * @param object the instance to compare to.

    * @return <code>true</code> if the given object is semantically equal to the

    *         given object, <code>false</code> otherwise.

    */

   @Override

   public boolean equals(final Object object)

   {

     if (this == object)

     {

       return true;

     }

     else if (object == null || getClass() != object.getClass())

     {

       return false;

     }

     final ArtifactId other = (ArtifactId) object;

     return (ObjectUtils.equals(name, other.name)

             && ObjectUtils.equals(groupId, other.groupId)

             && ObjectUtils.equals(version, other.version)

             && ObjectUtils.equals(archiveType, other.archiveType) && ObjectUtils

         .equals(classifier, other.classifier));

   }

   /**

    * {@inheritDoc}

    *

    * @see java.lang.Comparable#compareTo(java.lang.Object)

    */

   @Override

   public int compareTo(final ArtifactId o)

   {

     int result = ObjectUtils.compare(name, o.name);

     if (result == 0)

     {

       result = ObjectUtils.compare(groupId, o.groupId);

       if (result == 0)

       {

         result = ObjectUtils.compare(version, o.version);

         if (result == 0)

         {

           result = ObjectUtils.compare(archiveType, o.archiveType);

           // CHECKSTYLE:OFF

           if (result == 0) // NOPMD

           {

             result = ObjectUtils.compare(classifier, o.classifier);

           }

           // CHECKSTYLE:ON

         }

       }

     }

     return result;

   }

   /**

    * Returns the short string representation of the object.

    *

    * @return the short string representation of the object.

    */

   public String toShortString()

   {

     final StringBuilder buffer = new StringBuilder();

     buffer.append(groupId);

     buffer.append(':');

     buffer.append(name);

     buffer.append(':');

     buffer.append(version);

     return buffer.toString();

   }

   /**

    * Returns the string representation of the object.

    *

    * @return the string representation of the object.

    */

   @Override

   public String toString()

   {

     final StringBuilder buffer = new StringBuilder();

     buffer.append(groupId);

     buffer.append(':');

     buffer.append(name);

     buffer.append(':');

     buffer.append(version);

     buffer.append(':');

     buffer.append(archiveType);

     if (classifier != null)

     {

       buffer.append(':');

       buffer.append(classifier);

     }

     return buffer.toString();

   }

 }