001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.util.artifact;
020
021/**
022 * The dependency scopes that Resolver supports out of the box. The full set of scopes should be defined by
023 * consumer project.
024 * <p>
025 * By definition, scopes for Resolver are just labels, checked for equality. Resolver will not interpret, alter or
026 * modify any scope "label" that is not present in this class. It is left to consumer projects to define and
027 * interpret those.
028 *
029 * @see org.eclipse.aether.graph.Dependency#getScope()
030 * @since 2.0.0
031 */
032public final class DependencyScopes {
033
034    /**
035     * Special scope that tells resolver that dependency is not to be found in any regular repository, so it should not
036     * even try to resolve the artifact from them. Dependency in this scope does not have artifact descriptor either.
037     * Artifacts in this scope should have the "local path" property set, pointing to a file on local system, where the
038     * backing file should reside. Resolution of artifacts in this scope fails, if backing file does not exist
039     * (no property set, or property contains invalid path, or the path points to a non-existent file).
040     *
041     * @see org.eclipse.aether.artifact.ArtifactProperties#LOCAL_PATH
042     */
043    public static final String SYSTEM = "system";
044
045    private DependencyScopes() {
046        // hide constructor
047    }
048}