001package org.apache.maven.classrealm;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.File;
023
024/**
025 * Describes a constituent of a class realm.
026 * 
027 * @author Benjamin Bentmann
028 */
029public interface ClassRealmConstituent
030{
031
032    /**
033     * Gets the group id of the constituent's artifact.
034     * 
035     * @return The group id, never {@code null}.
036     */
037    String getGroupId();
038
039    /**
040     * Gets the artifact id of the constituent's artifact.
041     * 
042     * @return The artifact id, never {@code null}.
043     */
044    String getArtifactId();
045
046    /**
047     * Gets the type of the constituent's artifact.
048     * 
049     * @return The type, never {@code null}.
050     */
051    String getType();
052
053    /**
054     * Gets the classifier of the constituent's artifact.
055     * 
056     * @return The classifier or an empty string, never {@code null}.
057     */
058    String getClassifier();
059
060    /**
061     * Gets the version of the constituent's artifact.
062     * 
063     * @return The version, never {@code null}.
064     */
065    String getVersion();
066
067    /**
068     * Gets the file of the constituent's artifact.
069     * 
070     * @return The file, never {@code null}.
071     */
072    File getFile();
073
074}