View Javadoc
1   package org.apache.maven.plugins.dependency.utils.markers;
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.Artifact;
23  import org.apache.maven.plugin.MojoExecutionException;
24  
25  /**
26   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
27   */
28  public interface MarkerHandler
29  {
30      /**
31       * @return true/false.
32       * @throws MojoExecutionException in case of an error.
33       */
34      boolean isMarkerSet()
35          throws MojoExecutionException;
36  
37      /**
38       * @throws MojoExecutionException in case of an error.
39       */
40      void setMarker()
41          throws MojoExecutionException;
42  
43      /**
44       * @return true/false.
45       * @throws MojoExecutionException in case of an error.
46       */
47      boolean clearMarker()
48          throws MojoExecutionException;
49  
50      /**
51       * @param artifact {@link Artifact}
52       * @return true/false.
53       * @throws MojoExecutionException in case of an error.
54       */
55      boolean isMarkerOlder( Artifact artifact )
56          throws MojoExecutionException;
57  
58      /**
59       * @param artifact {@link Artifact}
60       */
61      void setArtifact( Artifact artifact );
62  
63  }