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