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.scope;
020
021/**
022 * Generic dependency scope.
023 *
024 * @since 2.0.0
025 *
026 * @noimplement This interface is not intended to be implemented by clients.
027 * @noextend This interface is not intended to be extended by clients.
028 */
029public interface DependencyScope {
030    /**
031     * The label.
032     *
033     * @return The identifier of this dependency scope, never {@code null}.
034     */
035    String getId();
036
037    /**
038     * Shorthand method of {@code getId().equals(String label)}.
039     *
040     * @param label The label to compare against, must not be {@code null}.
041     * @return {@code true} if this scope's identifier equals the given label, {@code false} otherwise.
042     */
043    default boolean is(String label) {
044        return getId().equals(label);
045    }
046
047    /**
048     * Is it transitive scope?
049     *
050     * @return {@code true} if dependencies in this scope are transitive, {@code false} otherwise.
051     */
052    boolean isTransitive();
053}