View Javadoc
1   /*******************************************************************************
2    * Copyright (c) 2010, 2013 Sonatype, Inc.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *    Sonatype, Inc. - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.aether.artifact;
12  
13  /**
14   * The keys for common properties of artifacts.
15   * 
16   * @see Artifact#getProperties()
17   */
18  public final class ArtifactProperties
19  {
20  
21      /**
22       * A high-level characterization of the artifact, e.g. "maven-plugin" or "test-jar".
23       * 
24       * @see ArtifactType#getId()
25       */
26      public static final String TYPE = "type";
27  
28      /**
29       * The programming language this artifact is relevant for, e.g. "java" or "none".
30       */
31      public static final String LANGUAGE = "language";
32  
33      /**
34       * The (expected) path to the artifact on the local filesystem. An artifact which has this property set is assumed
35       * to be not present in any regular repository and likewise has no artifact descriptor. Artifact resolution will
36       * verify the path and resolve the artifact if the path actually denotes an existing file. If the path isn't valid,
37       * resolution will fail and no attempts to search local/remote repositories are made.
38       */
39      public static final String LOCAL_PATH = "localPath";
40  
41      /**
42       * A boolean flag indicating whether the artifact presents some kind of bundle that physically includes its
43       * dependencies, e.g. a fat WAR.
44       */
45      public static final String INCLUDES_DEPENDENCIES = "includesDependencies";
46  
47      /**
48       * A boolean flag indicating whether the artifact is meant to be used for the compile/runtime/test build path of a
49       * consumer project.
50       */
51      public static final String CONSTITUTES_BUILD_PATH = "constitutesBuildPath";
52  
53      /**
54       * The URL to a web page from which the artifact can be manually downloaded. This URL is not contacted by the
55       * repository system but serves as a pointer for the end user to assist in getting artifacts that are not published
56       * in a proper repository.
57       */
58      public static final String DOWNLOAD_URL = "downloadUrl";
59  
60      private ArtifactProperties()
61      {
62          // hide constructor
63      }
64  
65  }