001package org.eclipse.aether.artifact;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 * 
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 * 
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * The keys for common properties of artifacts.
024 * 
025 * @see Artifact#getProperties()
026 */
027public final class ArtifactProperties
028{
029
030    /**
031     * A high-level characterization of the artifact, e.g. "maven-plugin" or "test-jar".
032     * 
033     * @see ArtifactType#getId()
034     */
035    public static final String TYPE = "type";
036
037    /**
038     * The programming language this artifact is relevant for, e.g. "java" or "none".
039     */
040    public static final String LANGUAGE = "language";
041
042    /**
043     * The (expected) path to the artifact on the local filesystem. An artifact which has this property set is assumed
044     * to be not present in any regular repository and likewise has no artifact descriptor. Artifact resolution will
045     * verify the path and resolve the artifact if the path actually denotes an existing file. If the path isn't valid,
046     * resolution will fail and no attempts to search local/remote repositories are made.
047     */
048    public static final String LOCAL_PATH = "localPath";
049
050    /**
051     * A boolean flag indicating whether the artifact presents some kind of bundle that physically includes its
052     * dependencies, e.g. a fat WAR.
053     */
054    public static final String INCLUDES_DEPENDENCIES = "includesDependencies";
055
056    /**
057     * A boolean flag indicating whether the artifact is meant to be used for the compile/runtime/test build path of a
058     * consumer project.
059     */
060    public static final String CONSTITUTES_BUILD_PATH = "constitutesBuildPath";
061
062    /**
063     * The URL to a web page from which the artifact can be manually downloaded. This URL is not contacted by the
064     * repository system but serves as a pointer for the end user to assist in getting artifacts that are not published
065     * in a proper repository.
066     */
067    public static final String DOWNLOAD_URL = "downloadUrl";
068
069    private ArtifactProperties()
070    {
071        // hide constructor
072    }
073
074}