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.eclipse.aether.artifact; 20 21 import java.util.Map; 22 23 /** 24 * An artifact type describing artifact characteristics/properties that are common for certain artifacts. Artifact types 25 * are a means to simplify the description of an artifact by referring to an artifact type instead of specifying the 26 * various properties individually. 27 * 28 * @noimplement This interface is not intended to be implemented by clients. 29 * @noextend This interface is not intended to be extended by clients. 30 * @see ArtifactTypeRegistry 31 * @see DefaultArtifact#DefaultArtifact(String, String, String, String, String, ArtifactType) 32 */ 33 public interface ArtifactType { 34 35 /** 36 * Gets the identifier of this type, e.g. "maven-plugin" or "test-jar". 37 * 38 * @return The identifier of this type, never {@code null}. 39 * @see ArtifactProperties#TYPE 40 */ 41 String getId(); 42 43 /** 44 * Gets the file extension to use for artifacts of this type (unless explicitly overridden by the artifact). 45 * 46 * @return The usual file extension, never {@code null}. 47 */ 48 String getExtension(); 49 50 /** 51 * Gets the classifier to use for artifacts of this type (unless explicitly overridden by the artifact). 52 * 53 * @return The usual classifier or an empty string if none, never {@code null}. 54 */ 55 String getClassifier(); 56 57 /** 58 * Gets the properties to use for artifacts of this type (unless explicitly overridden by the artifact). 59 * 60 * @return The (read-only) properties, never {@code null}. 61 * @see ArtifactProperties 62 */ 63 Map<String, String> getProperties(); 64 }