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