View Javadoc

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