package org.eclipse.aether.artifact;

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

The keys for common properties of artifacts.
See Also:
getProperties.getProperties()/**
 * The keys for common properties of artifacts.
 * 
 * @see Artifact#getProperties()
 */
public final class ArtifactProperties
{

    
A high-level characterization of the artifact, e.g. "maven-plugin" or "test-jar".
See Also:
getId.getId()/**
     * A high-level characterization of the artifact, e.g. "maven-plugin" or "test-jar".
     * 
     * @see ArtifactType#getId()
     */
    public static final String TYPE = "type";

    
The programming language this artifact is relevant for, e.g. "java" or "none".
/**
     * The programming language this artifact is relevant for, e.g. "java" or "none".
     */
    public static final String LANGUAGE = "language";

    
The (expected) path to the artifact on the local filesystem. An artifact which has this property set is assumed
to be not present in any regular repository and likewise has no artifact descriptor. Artifact resolution will
verify the path and resolve the artifact if the path actually denotes an existing file. If the path isn't valid,
resolution will fail and no attempts to search local/remote repositories are made.
/**
     * The (expected) path to the artifact on the local filesystem. An artifact which has this property set is assumed
     * to be not present in any regular repository and likewise has no artifact descriptor. Artifact resolution will
     * verify the path and resolve the artifact if the path actually denotes an existing file. If the path isn't valid,
     * resolution will fail and no attempts to search local/remote repositories are made.
     */
    public static final String LOCAL_PATH = "localPath";

    
A boolean flag indicating whether the artifact presents some kind of bundle that physically includes its
dependencies, e.g. a fat WAR.
/**
     * A boolean flag indicating whether the artifact presents some kind of bundle that physically includes its
     * dependencies, e.g. a fat WAR.
     */
    public static final String INCLUDES_DEPENDENCIES = "includesDependencies";

    
A boolean flag indicating whether the artifact is meant to be used for the compile/runtime/test build path of a
consumer project.
/**
     * A boolean flag indicating whether the artifact is meant to be used for the compile/runtime/test build path of a
     * consumer project.
     */
    public static final String CONSTITUTES_BUILD_PATH = "constitutesBuildPath";

    
The URL to a web page from which the artifact can be manually downloaded. This URL is not contacted by the
repository system but serves as a pointer for the end user to assist in getting artifacts that are not published
in a proper repository.
/**
     * The URL to a web page from which the artifact can be manually downloaded. This URL is not contacted by the
     * repository system but serves as a pointer for the end user to assist in getting artifacts that are not published
     * in a proper repository.
     */
    public static final String DOWNLOAD_URL = "downloadUrl";

    private ArtifactProperties()
    {
        // hide constructor
    }

}