org.codehaus.mojo.rpm.Dependency Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rpm-maven-plugin Show documentation
Maven plugin which assembles files into an RPM package for installation on various target UNIX systems.
There is a newer version: 2.3.0
package org.codehaus.mojo.rpm;

/*
 * 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 java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.plugin.MojoExecutionException;

/**
 * A description of the set of project dependencies to include in the mapping. If no includes or excludes are specified,
 * all dependencies will be included in the mapping.
 * 
 * Each include or exclude should be specified in the form: 
 * "groupID:artifactID[:version]" Any field can be specified as 
 * "*" which means any value is a match. If version is omitted (it usually is), it is the same as 
 * specifying "*".
 * 
 * @version $Id: Dependency.java 8844 2009-01-20 23:33:27Z bokken $
 */
public class Dependency
{

    // // // Properties

    /** List of dependencies to include. */
    private List includes;

    /** List of dependencies to exclude. */
    private List excludes;

    // // // Bean methods

    /**
     * Retrieve the list of dependencies to include.
     * 
     * @return The list of dependencies to include.
     */
    public List getIncludes()
    {
        return includes;
    }

    /**
     * Set the list of dependencies to include.
     * 
     * @param incls The new list of dependencies to include.
     * @throws MojoExecutionException if the parse fails
     */
    public void setIncludes( List incls )
        throws MojoExecutionException
    {
        includes = parseList( incls );
    }

    /**
     * Retrieve the list of dependencies to exclude.
     * 
     * @return The list of dependencies to exclude.
     */
    public List getExcludes()
    {
        return excludes;
    }

    /**
     * Set the list of dependencies to exclude.
     * 
     * @param excls The new list of dependencies to exclude.
     * @throws MojoExecutionException if the parse fails
     */
    public void setExcludes( List excls )
        throws MojoExecutionException
    {
        excludes = parseList( excls );
    }

    // // // Public methods

    /** {@inheritDoc} */
    public String toString()
    {
        StringBuffer sb = new StringBuffer();
        sb.append( "[dependencies" );

        if ( includes != null )
        {
            sb.append( " include [" + includes + "]" );
        }

        if ( excludes != null )
        {
            sb.append( " exclude [" + excludes + "]" );
        }

        sb.append( "]" );
        return sb.toString();
    }

    // // // Private methods

    /**
     * Parse the list of dependencies.
     * 
     * @param in The list specified in the configuration
     * @return A list of parsed artifact identifiers
     * @throws MojoExecutionException if the parse fails
     */
    private List parseList( List in )
        throws MojoExecutionException
    {
        List retval = new ArrayList();

        for ( Iterator it = in.iterator(); it.hasNext(); )
        {
            String s = (String) it.next();

            // Make sure we have group and artifact
            int p1 = s.indexOf( ":" );
            if ( p1 == -1 )
            {
                throw new MojoExecutionException( "Include and exclude must include both group and artifact IDs." );
            }

            // Find end of artifact and create version range
            int p2 = s.indexOf( ":", ( p1 + 1 ) );
            VersionRange vr = null;
            if ( p2 == -1 )
            {
                p2 = s.length();
                try
                {
                    vr = VersionRange.createFromVersionSpec( "[0,]" );
                }
                catch ( InvalidVersionSpecificationException ex )
                {
                    throw new MojoExecutionException( "Default version string is invalid!" );
                }
            }
            else
            {
                try
                {
                    vr = VersionRange.createFromVersionSpec( s.substring( p2 + 1 ) );
                }
                catch ( InvalidVersionSpecificationException ex )
                {
                    throw new MojoExecutionException( "Version string " + s.substring( p2 + 1 ) + " is invalid." );
                }
            }
            retval.add( 
                new DefaultArtifact( s.substring( 0, p1 ), s.substring( p1 + 1, p2 ), vr, null, "", "", null ) );
        }

        return retval;
    }
}