View Javadoc
1   package org.apache.maven.plugins.dependency.fromConfiguration;
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  /**
23   * @author Olivier Lamy
24   * @since 2.7
25   */
26  public class ProcessArtifactItemsRequest
27  {
28      /**
29       * remove the version from the filename.
30       */
31      private boolean removeVersion;
32  
33      /**
34       * remove the classifier from the filename.
35       */
36      private boolean removeClassifier;
37  
38      /**
39       * prepend the groupId to the filename.
40       */
41      private boolean prependGroupId;
42  
43      /**
44       * use the baseVersion of the artifact instead of version for the filename.
45       */
46      private boolean useBaseVersion;
47  
48      /**
49       * Default ctor.
50       */
51      public ProcessArtifactItemsRequest()
52      {
53          // no op
54      }
55  
56      /**
57       * @param removeVersion {@link #removeVersion}
58       * @param prependGroupId {@link #prependGroupId}
59       * @param useBaseVersion {@link #useBaseVersion}
60       * @param removeClassifier {@link #removeClassifier}
61       */
62      public ProcessArtifactItemsRequest( boolean removeVersion, boolean prependGroupId, boolean useBaseVersion,
63                                          boolean removeClassifier )
64      {
65          this.removeVersion = removeVersion;
66          this.prependGroupId = prependGroupId;
67          this.useBaseVersion = useBaseVersion;
68          this.removeClassifier = removeClassifier;
69      }
70  
71      /**
72       * @return {@link #removeVersion}
73       */
74      public boolean isRemoveVersion()
75      {
76          return removeVersion;
77      }
78  
79      /**
80       * @param removeVersion {@link #removeVersion}
81       */
82      public void setRemoveVersion( boolean removeVersion )
83      {
84          this.removeVersion = removeVersion;
85      }
86  
87      /**
88       * @return {@link #removeClassifier}
89       */
90      public boolean isRemoveClassifier()
91      {
92          return removeClassifier;
93      }
94  
95      /**
96       * @param removeClassifier {@link #removeClassifier}
97       */
98      public void setRemoveClassifier( boolean removeClassifier )
99      {
100         this.removeClassifier = removeClassifier;
101     }
102 
103     /**
104      * @param theRemoveVersion {@link #removeVersion}
105      * @return {@link ProcessArtifactItemsRequest}
106      */
107     public ProcessArtifactItemsRequest removeVersion( boolean theRemoveVersion )
108     {
109         this.removeVersion = theRemoveVersion;
110         return this;
111     }
112 
113     /**
114      * @return {@link #prependGroupId}
115      */
116     public boolean isPrependGroupId()
117     {
118         return prependGroupId;
119     }
120 
121     /**
122      * @param prependGroupId {@link #prependGroupId}
123      */
124     public void setPrependGroupId( boolean prependGroupId )
125     {
126         this.prependGroupId = prependGroupId;
127     }
128 
129     /**
130      * @param thePrependGroupId {@link #prependGroupId}
131      * @return {@link ProcessArtifactItemsRequest}
132      */
133     public ProcessArtifactItemsRequest prependGroupId( boolean thePrependGroupId )
134     {
135         this.prependGroupId = thePrependGroupId;
136         return this;
137     }
138 
139     /**
140      * @return {@link #useBaseVersion}
141      */
142     public boolean isUseBaseVersion()
143     {
144         return useBaseVersion;
145     }
146 
147     /**
148      * @param useBaseVersion {@link #useBaseVersion}
149      */
150     public void setUseBaseVersion( boolean useBaseVersion )
151     {
152         this.useBaseVersion = useBaseVersion;
153     }
154 
155     /**
156      * @param theUseBaseVersion {@link #useBaseVersion}
157      * @return {@link ProcessArtifactItemsRequest}
158      */
159     public ProcessArtifactItemsRequest useBaseVersion( boolean theUseBaseVersion )
160     {
161         this.useBaseVersion = theUseBaseVersion;
162         return this;
163     }
164 }