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.cache;
20
21 import org.apache.maven.api.annotations.Experimental;
22 import org.apache.maven.api.annotations.Nullable;
23
24 /**
25 * Interface defining metadata for cache behavior and lifecycle management.
26 * Implementations can specify how long cached data should be retained.
27 *
28 * @since 4.0.0
29 */
30 @Experimental
31 public interface CacheMetadata {
32
33 /**
34 * Returns the cache retention that should be applied to the associated data.
35 *
36 * @return The CacheRetention indicating how long data should be retained, or null if
37 * no specific cache retention is defined
38 */
39 @Nullable
40 CacheRetention getCacheRetention();
41 }