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.model.building;
20
21 /**
22 * Caches auxiliary data used during model building like already processed raw/effective models. The data in the cache
23 * is meant for exclusive consumption by the model builder and is opaque to the cache implementation. The cache key is
24 * formed by a combination of group id, artifact id, version and tag. The first three components generally refer to the
25 * identify of a model. The tag allows for further classification of the associated data on the sole discretion of the
26 * model builder.
27 *
28 * @author Benjamin Bentmann
29 */
30 public interface ModelCache {
31
32 /**
33 * Puts the specified data into the cache.
34 *
35 * @param groupId The group id of the cache record, must not be {@code null}.
36 * @param artifactId The artifact id of the cache record, must not be {@code null}.
37 * @param version The version of the cache record, must not be {@code null}.
38 * @param tag The tag of the cache record, must not be {@code null}.
39 * @param data The data to store in the cache, must not be {@code null}.
40 */
41 void put(String groupId, String artifactId, String version, String tag, Object data);
42
43 /**
44 * Gets the specified data from the cache.
45 *
46 * @param groupId The group id of the cache record, must not be {@code null}.
47 * @param artifactId The artifact id of the cache record, must not be {@code null}.
48 * @param version The version of the cache record, must not be {@code null}.
49 * @param tag The tag of the cache record, must not be {@code null}.
50 * @return The requested data or {@code null} if none was present in the cache.
51 */
52 Object get(String groupId, String artifactId, String version, String tag);
53 }