View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.api;
20  
21  import org.apache.maven.api.annotations.Experimental;
22  import org.apache.maven.api.annotations.Immutable;
23  import org.apache.maven.api.annotations.Nonnull;
24  
25  /**
26   *
27   * @since 4.0.0
28   */
29  @Experimental
30  @Immutable
31  public interface Dependency extends Artifact {
32  
33      /**
34       * The dependency type.
35       *
36       * @return the dependency type, never {@code null}
37       */
38      @Nonnull
39      Type getType();
40  
41      @Nonnull
42      DependencyScope getScope();
43  
44      boolean isOptional();
45  
46      /**
47       * Creates a {@code DependencyCoordinate} based on this {@code Dependency}.
48       *
49       * @return a {@link DependencyCoordinate}
50       */
51      @Nonnull
52      @Override
53      DependencyCoordinate toCoordinate();
54  }