1 package org.eclipse.aether.metadata;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23 import java.util.Map;
24
25 /**
26 * A piece of repository metadata, e.g. an index of available versions. In contrast to an artifact, which usually exists
27 * in only one repository, metadata usually exists in multiple repositories and each repository contains a different
28 * copy of the metadata. <em>Note:</em> Metadata instances are supposed to be immutable, e.g. any exposed mutator method
29 * returns a new metadata instance and leaves the original instance unchanged. Implementors are strongly advised to obey
30 * this contract. <em>Note:</em> Implementors are strongly advised to inherit from {@link AbstractMetadata} instead of
31 * directly implementing this interface.
32 *
33 * @noimplement This interface is not intended to be implemented by clients.
34 * @noextend This interface is not intended to be extended by clients.
35 */
36 public interface Metadata
37 {
38
39 /**
40 * The nature of the metadata.
41 */
42 enum Nature
43 {
44 /**
45 * The metadata refers to release artifacts only.
46 */
47 RELEASE,
48
49 /**
50 * The metadata refers to snapshot artifacts only.
51 */
52 SNAPSHOT,
53
54 /**
55 * The metadata refers to either release or snapshot artifacts.
56 */
57 RELEASE_OR_SNAPSHOT
58 }
59
60 /**
61 * Gets the group identifier of this metadata.
62 *
63 * @return The group identifier or an empty string if the metadata applies to the entire repository, never
64 * {@code null}.
65 */
66 String getGroupId();
67
68 /**
69 * Gets the artifact identifier of this metadata.
70 *
71 * @return The artifact identifier or an empty string if the metadata applies to the groupId level only, never
72 * {@code null}.
73 */
74 String getArtifactId();
75
76 /**
77 * Gets the version of this metadata.
78 *
79 * @return The version or an empty string if the metadata applies to the groupId:artifactId level only, never
80 * {@code null}.
81 */
82 String getVersion();
83
84 /**
85 * Gets the type of the metadata, e.g. "maven-metadata.xml".
86 *
87 * @return The type of the metadata, never {@code null}.
88 */
89 String getType();
90
91 /**
92 * Gets the nature of this metadata. The nature indicates to what artifact versions the metadata refers.
93 *
94 * @return The nature, never {@code null}.
95 */
96 Nature getNature();
97
98 /**
99 * Gets the file of this metadata. Note that only resolved metadata has a file associated with it.
100 *
101 * @return The file or {@code null} if none.
102 */
103 File getFile();
104
105 /**
106 * Sets the file of the metadata.
107 *
108 * @param file The file of the metadata, may be {@code null}
109 * @return The new metadata, never {@code null}.
110 */
111 Metadata setFile( File file );
112
113 /**
114 * Gets the specified property.
115 *
116 * @param key The name of the property, must not be {@code null}.
117 * @param defaultValue The default value to return in case the property is not set, may be {@code null}.
118 * @return The requested property value or {@code null} if the property is not set and no default value was
119 * provided.
120 */
121 String getProperty( String key, String defaultValue );
122
123 /**
124 * Gets the properties of this metadata.
125 *
126 * @return The (read-only) properties, never {@code null}.
127 */
128 Map<String, String> getProperties();
129
130 /**
131 * Sets the properties for the metadata.
132 *
133 * @param properties The properties for the metadata, may be {@code null}.
134 * @return The new metadata, never {@code null}.
135 */
136 Metadata setProperties( Map<String, String> properties );
137
138 }