View Javadoc
1   package org.apache.maven.tools.plugin.extractor.annotations;
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 java.util.List;
23  
24  import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
25  import org.apache.maven.plugin.MojoExecutionException;
26  import org.apache.maven.plugin.MojoFailureException;
27  import org.apache.maven.plugins.annotations.Component;
28  import org.apache.maven.plugins.annotations.Execute;
29  import org.apache.maven.plugins.annotations.LifecyclePhase;
30  import org.apache.maven.plugins.annotations.Mojo;
31  import org.apache.maven.plugins.annotations.Parameter;
32  
33  /**
34   * @author Olivier Lamy
35   */
36  @Mojo( name = "foo", defaultPhase = LifecyclePhase.COMPILE, threadSafe = true )
37  @Execute( goal = "compiler", lifecycle = "my-lifecycle", phase = LifecyclePhase.PACKAGE )
38  public class FooMojo
39      extends AbstractFooMojo
40  {
41      /**
42       * the cool bar to go
43       * @since 1.0
44       */
45      @Parameter( property = "thebar", required = true, defaultValue = "coolbar" )
46      protected String bar;
47  
48      /**
49       * Setter method for Parameter field
50       */
51      public void setBar( String bar )
52      {
53          this.bar = bar;
54      }
55  
56      /**
57       * beer for non french folks
58       * @deprecated wine is better
59       */
60      @Deprecated
61      @Parameter( property = "thebeer", defaultValue = "coolbeer" )
62      protected String beer;
63  
64      /**
65       * Field for setter method
66       */
67      private String paramFromSetter;
68  
69      /**
70       * setter as parameter.
71       */
72      @Parameter( property = "props.paramFromSetter" )
73      public void setParamFromSetter(String value)
74      {
75          this.paramFromSetter = paramFromSetter;
76      }
77  
78      /**
79       * add method as parameter.
80       */
81      @Parameter( property = "props.paramFromAdd" )
82      public void addParamFromAdd(String value)
83      {
84          // empty
85      }
86  
87      /**
88       * deprecated setter as parameter.
89       *
90       * @deprecated reason of deprecation
91       */
92      @Deprecated
93      @Parameter( property = "props.paramFromSetterDeprecated" )
94      public void setParamFromSetterDeprecated( List<String> value)
95      {
96          // empty
97      }
98  
99      /**
100      * Static methods should be excluded.
101      */
102     @Parameter
103     public static void setStaticMethod( String value )
104     {
105         // empty
106     }
107 
108     /**
109      *
110      */
111     @Component( role = ArtifactMetadataSource.class, hint = "maven" )
112     protected ArtifactMetadataSource artifactMetadataSource;
113 
114     @Override
115     public void execute()
116         throws MojoExecutionException, MojoFailureException
117     {
118         // nothing
119     }
120 
121     @Deprecated
122     public void deprecatedMethod(String value)
123     {
124 
125     }
126 }