View Javadoc

1   /**
2    * Copyright 2010-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.maven.plugins.graph.mojo;
17  
18  import org.apache.maven.artifact.factory.ArtifactFactory;
19  import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
20  import org.apache.maven.artifact.repository.ArtifactRepository;
21  import org.apache.maven.artifact.resolver.ArtifactCollector;
22  import org.apache.maven.artifact.resolver.ArtifactResolver;
23  import org.apache.maven.plugin.AbstractMojo;
24  import org.apache.maven.project.MavenProject;
25  import org.apache.maven.shared.dependency.tree.DependencyTreeBuilder;
26  
27  /**
28   * <p>
29   * </p>
30   *
31   */
32  @SuppressWarnings("deprecation")
33  public abstract class BaseMavenMojo extends AbstractMojo {
34  
35      /**
36       * @required
37       * @readonly
38       * @parameter expression="${project}"
39       * @since 1.0
40       */
41      private MavenProject project;
42  
43      /**
44       * @required
45       * @readonly
46       * @parameter expression="${localRepository}"
47       * @since 1.0
48       */
49      private ArtifactRepository localRepository;
50  
51      /**
52       * @required
53       * @component
54       * @since 1.0
55       */
56      private ArtifactResolver artifactResolver;
57  
58      /**
59       * @required
60       * @readonly
61       * @component
62       * @since 1.0
63       */
64      private ArtifactFactory artifactFactory;
65  
66      /**
67       * @required
68       * @readonly
69       * @component
70       * @since 1.0
71       */
72      private ArtifactMetadataSource artifactMetadataSource;
73  
74      /**
75       * @required
76       * @readonly
77       * @component
78       */
79      private ArtifactCollector artifactCollector;
80  
81      /**
82       * @required
83       * @readonly
84       * @component
85       * @since 1.0
86       */
87      private DependencyTreeBuilder treeBuilder;
88  
89      /**
90       * <p>
91       * If true, mojo execution is skipped.
92       * </p>
93       *
94       * @parameter expression="${graph.skip}" default-value="false"
95       */
96      private boolean skip;
97  
98      /**
99       * <p>
100      * If true, metadata about the dependency tree is displayed.
101      * </p>
102      *
103      * @parameter expression="${graph.verbose}" default-value="false"
104      */
105     private boolean verbose;
106 
107     public MavenProject getProject() {
108         return project;
109     }
110 
111     public void setProject(MavenProject project) {
112         this.project = project;
113     }
114 
115     public ArtifactRepository getLocalRepository() {
116         return localRepository;
117     }
118 
119     public void setLocalRepository(ArtifactRepository localRepository) {
120         this.localRepository = localRepository;
121     }
122 
123     public ArtifactResolver getArtifactResolver() {
124         return artifactResolver;
125     }
126 
127     public void setArtifactResolver(ArtifactResolver artifactResolver) {
128         this.artifactResolver = artifactResolver;
129     }
130 
131     public ArtifactFactory getArtifactFactory() {
132         return artifactFactory;
133     }
134 
135     public void setArtifactFactory(ArtifactFactory artifactFactory) {
136         this.artifactFactory = artifactFactory;
137     }
138 
139     public ArtifactMetadataSource getArtifactMetadataSource() {
140         return artifactMetadataSource;
141     }
142 
143     public void setArtifactMetadataSource(ArtifactMetadataSource artifactMetadataSource) {
144         this.artifactMetadataSource = artifactMetadataSource;
145     }
146 
147     public ArtifactCollector getArtifactCollector() {
148         return artifactCollector;
149     }
150 
151     public void setArtifactCollector(ArtifactCollector artifactCollector) {
152         this.artifactCollector = artifactCollector;
153     }
154 
155     public DependencyTreeBuilder getTreeBuilder() {
156         return treeBuilder;
157     }
158 
159     public void setTreeBuilder(DependencyTreeBuilder treeBuilder) {
160         this.treeBuilder = treeBuilder;
161     }
162 
163     public boolean isSkip() {
164         return skip;
165     }
166 
167     public void setSkip(boolean skip) {
168         this.skip = skip;
169     }
170 
171     public boolean isVerbose() {
172         return verbose;
173     }
174 
175     public void setVerbose(boolean verbose) {
176         this.verbose = verbose;
177     }
178 
179 }