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.api.services.model;
20
21 import org.apache.maven.api.annotations.Experimental;
22 import org.apache.maven.api.annotations.Nonnull;
23
24 /**
25 * Factory for creating model caches.
26 * <p>
27 * The model cache is meant for exclusive consumption by the model builder and is opaque to the cache implementation.
28 * The cache is created once per session and is valid through the lifetime of the session.
29 * <p>
30 * The cache implementation could be annotated with {@code SessionScoped} to be created once per session, but
31 * this would make tests more complicated to write as they would all need to enter the session scope.
32 * This is similar to the {@code CIFriendlyVersionModelTransformer}.
33 *
34 * @since 4.0.0
35 */
36 @Experimental
37 public interface ModelCacheFactory {
38
39 @Nonnull
40 ModelCache newInstance();
41 }