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.classrealm;
20  
21  import java.io.File;
22  
23  /**
24   * Describes a constituent of a class realm.
25   *
26   * @author Benjamin Bentmann
27   */
28  public interface ClassRealmConstituent {
29  
30      /**
31       * Gets the group id of the constituent's artifact.
32       *
33       * @return The group id, never {@code null}.
34       */
35      String getGroupId();
36  
37      /**
38       * Gets the artifact id of the constituent's artifact.
39       *
40       * @return The artifact id, never {@code null}.
41       */
42      String getArtifactId();
43  
44      /**
45       * Gets the type of the constituent's artifact.
46       *
47       * @return The type, never {@code null}.
48       */
49      String getType();
50  
51      /**
52       * Gets the classifier of the constituent's artifact.
53       *
54       * @return The classifier or an empty string, never {@code null}.
55       */
56      String getClassifier();
57  
58      /**
59       * Gets the version of the constituent's artifact.
60       *
61       * @return The version, never {@code null}.
62       */
63      String getVersion();
64  
65      /**
66       * Gets the file of the constituent's artifact.
67       *
68       * @return The file, never {@code null}.
69       */
70      File getFile();
71  }