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