View Javadoc

1   package org.apache.maven.artifact.repository.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 org.apache.maven.artifact.repository.ArtifactRepository;
23  import org.apache.maven.artifact.repository.ArtifactRepositoryPolicy;
24  
25  /**
26   * Describes repository directory metadata.
27   *
28   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
29   * @version $Id: RepositoryMetadata.java 950240 2010-06-01 20:39:34Z hboutemy $
30   * @todo not happy about the store method - they use "this"
31   */
32  public interface RepositoryMetadata
33      extends org.apache.maven.artifact.metadata.ArtifactMetadata
34  {
35  
36      int RELEASE = 1;
37  
38      int SNAPSHOT = 2;
39  
40      int RELEASE_OR_SNAPSHOT = RELEASE | SNAPSHOT;
41  
42      /**
43       * Get the repository the metadata was located in.
44       *
45       * @return the repository
46       */
47      ArtifactRepository getRepository();
48  
49      /**
50       * Set the repository the metadata was located in.
51       *
52       * @param remoteRepository the repository
53       */
54      void setRepository( ArtifactRepository remoteRepository );
55  
56      /**
57       * Get the repository metadata associated with this marker.
58       *
59       * @return the metadata, or <code>null</code> if none loaded
60       */
61      Metadata getMetadata();
62  
63      /**
64       * Set the metadata contents.
65       *
66       * @param metadata the metadata
67       */
68      void setMetadata( Metadata metadata );
69  
70      /**
71       * Whether this represents a snapshot.
72       *
73       * @return if it is a snapshot
74       */
75      boolean isSnapshot();
76  
77      /**
78       * Gets the artifact quality this metadata refers to. One of {@link #RELEASE}, {@link #SNAPSHOT} or
79       * {@link #RELEASE_OR_SNAPSHOT}.
80       *
81       * @return The artifact quality this metadata refers to.
82       */
83      int getNature();
84  
85      /**
86       * Gets the policy that applies to this metadata regarding the specified repository.
87       *
88       * @param repository The repository for which to determine the policy, must not be {@code null}.
89       * @return The policy, never {@code null}.
90       */
91      ArtifactRepositoryPolicy getPolicy( ArtifactRepository repository );
92  
93  }