org.apache.maven.artifact.handler.ArtifactHandler.java Source code

Introduction

Here is the source code for org.apache.maven.artifact.handler.ArtifactHandler.java

Source

package org.apache.maven.artifact.handler;

/*
 * 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.
 */

/**
 * An artifact handler defines for a dependency type, defined as Plexus role:<ul>
 * <li>extension and classifier, to be able to download the file,</li>
 * <li>information on how to use the artifact: whether to add it to the classpath, or to take into account its
 * dependencies.</li>
 * </ul>
 * 
 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
 */
public interface ArtifactHandler {
    String ROLE = ArtifactHandler.class.getName();

    /**
     * Get the file extension associated to the file represented by the dependency type.
     *
     * @return the file extension
     */
    String getExtension();

    String getDirectory();

    /**
     * Get the classifier associated to the dependency type.
     * 
     * @return the classifier
     */
    String getClassifier();

    String getPackaging();

    boolean isIncludesDependencies();

    String getLanguage();

    boolean isAddedToClasspath();
}