org.apache.maven.archiva.model.AbstractArtifactKey Maven / Gradle / Ivy

Go to download
package org.apache.maven.archiva.model;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import org.apache.commons.lang.StringUtils;

import java.io.Serializable;

/**
 * 
 * AbstractArtifactKey - a artifact reference to a versioned project.
 * This refers to all artifacts of a specific version of a project.
 * This type of reference is typically used by {@link ArchivaProjectModel} objects. 
 * 
 * 
 * 
 *   If you don't require things like "Version" or "Type", consider the other keys below.
 * 
 * 
 * 
 *   
 *     
 *     
 *     
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *     
 *     
 *     
 *   
 * Key Type Group ID Artifact ID Version Classifier Type
{@link AbstractProjectKey} Yes Yes      
{@link AbstractVersionedKey} Yes Yes Yes    
{@link AbstractArtifactKey} Yes Yes Yes Yes Yes
 * 
 * 
 * NOTE: This is a jpox required compound key handler class.
 * 
 *
 * @author Joakim Erdfelt
 * @version $Id: AbstractArtifactKey.java 562485 2007-08-03 14:44:15Z joakime $
 */
public class AbstractArtifactKey
    implements CompoundKey, Serializable
{
    private static final long serialVersionUID = 1084250769223555422L;

    /**
     * The Group ID. (JPOX Requires this remain public)
     */
    public String groupId = "";

    /**
     * The Artifact ID. (JPOX Requires this remain public)
     */
    public String artifactId = "";

    /**
     * The Version. (JPOX Requires this remain public)
     */
    public String version = "";

    /**
     * The Classifier. (JPOX Requires this remain public)
     */
    public String classifier = "";

    /**
     * The Type. (JPOX Requires this remain public)
     */
    public String type = "";

    /**
     * Default Constructor.  Required by JPOX.
     */
    public AbstractArtifactKey()
    {
        /* do nothing */
    }

    /**
     * Key Based Constructor.  Required by JPOX.
     * 
     * @param key the String representing this object's values.
     */
    public AbstractArtifactKey( String key )
    {
        String parts[] = StringUtils.splitPreserveAllTokens( key, ":" );
        groupId = parts[0];
        artifactId = parts[1];
        version = parts[2];
        classifier = parts[3];
        type = parts[4];
    }

    /**
     * Get the String representation of this object. - Required by JPOX.
     */
    public String toString()
    {
        return StringUtils.join( new String[] { groupId, artifactId, version, classifier, type }, ':' );
    }

    /**
     * Get the hashcode for this object's values - Required by JPOX.
     */
    public int hashCode()
    {
        final int PRIME = 31;
        int result = super.hashCode();
        result = PRIME * result + ( ( groupId == null ) ? 0 : groupId.hashCode() );
        result = PRIME * result + ( ( artifactId == null ) ? 0 : artifactId.hashCode() );
        result = PRIME * result + ( ( version == null ) ? 0 : version.hashCode() );
        result = PRIME * result + ( ( classifier == null ) ? 0 : classifier.hashCode() );
        result = PRIME * result + ( ( type == null ) ? 0 : type.hashCode() );
        return result;
    }

    /**
     * Get the equals for this object's values - Required by JPOX.
     */
    public boolean equals( Object obj )
    {
        if ( this == obj )
        {
            return true;
        }

        if ( !super.equals( obj ) )
        {
            return false;
        }

        if ( getClass() != obj.getClass() )
        {
            return false;
        }

        final AbstractArtifactKey other = (AbstractArtifactKey) obj;

        if ( groupId == null )
        {
            if ( other.groupId != null )
            {
                return false;
            }
        }
        else if ( !groupId.equals( other.groupId ) )
        {
            return false;
        }

        if ( artifactId == null )
        {
            if ( other.artifactId != null )
            {
                return false;
            }
        }
        else if ( !artifactId.equals( other.artifactId ) )
        {
            return false;
        }

        if ( version == null )
        {
            if ( other.version != null )
            {
                return false;
            }
        }
        else if ( !version.equals( other.version ) )
        {
            return false;
        }

        if ( classifier == null )
        {
            if ( other.classifier != null )
            {
                return false;
            }
        }
        else if ( !classifier.equals( other.classifier ) )
        {
            return false;
        }

        if ( type == null )
        {
            if ( other.type != null )
            {
                return false;
            }
        }
        else if ( !type.equals( other.type ) )
        {
            return false;
        }

        return true;
    }

    public void setGroupId( String groupId )
    {
        if ( StringUtils.isBlank( groupId ) )
        {
            throw new IllegalArgumentException( "A blank Group ID is not allowed." );
        }

        this.groupId = groupId;
    }

    public void setArtifactId( String artifactId )
    {
        if ( StringUtils.isBlank( artifactId ) )
        {
            throw new IllegalArgumentException( "A blank Artifact ID is not allowed." );
        }

        this.artifactId = artifactId;
    }

    public void setVersion( String version )
    {
        if ( StringUtils.isBlank( artifactId ) )
        {
            throw new IllegalArgumentException( "A blank version is not allowed." );
        }

        this.version = version;
    }

    public void setClassifier( String classifier )
    {
        this.classifier = "";

        if ( StringUtils.isNotBlank( classifier ) )
        {
            this.classifier = classifier;
        }
    }

    public void setType( String type )
    {
        this.type = "";

        if ( StringUtils.isNotBlank( type ) )
        {
            this.type = type;
        }
    }

}
Key Type	Group ID	Artifact ID	Version	Classifier	Type
{@link AbstractProjectKey}	Yes	Yes
{@link AbstractVersionedKey}	Yes	Yes	Yes
{@link AbstractArtifactKey}	Yes	Yes	Yes	Yes	Yes