View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   //  Generated by Modello Velocity from model.vm
3   //  template, any modifications will be overwritten.
4   // ==============================================================
5   package org.apache.maven.api.model;
6   
7   import java.io.Serializable;
8   import java.util.Collections;
9   import java.util.HashMap;
10  import java.util.Map;
11  import java.util.Objects;
12  import java.util.Optional;
13  import java.util.Set;
14  import java.util.stream.Collectors;
15  import java.util.stream.Stream;
16  import org.apache.maven.api.annotations.Experimental;
17  import org.apache.maven.api.annotations.Generated;
18  import org.apache.maven.api.annotations.Immutable;
19  import org.apache.maven.api.annotations.Nonnull;
20  import org.apache.maven.api.annotations.NotThreadSafe;
21  import org.apache.maven.api.annotations.ThreadSafe;
22  
23  /**
24   * The {@code <exclusion>} element contains information required to exclude
25   * an artifact to the project.
26   * <p>
27   * The {@code groupId} and {@code artifactId} fields are interpreted as glob patterns.
28   * 
29   * @see java.nio.file.FileSystem#getPathMatcher
30   */
31  @Experimental
32  @Generated @ThreadSafe @Immutable
33  public class Exclusion
34      implements Serializable, InputLocationTracker
35  {
36      /**
37       * The group ID of the project to exclude.
38       */
39      final String groupId;
40      /**
41       * The artifact ID of the project to exclude.
42       */
43      final String artifactId;
44      /** Locations */
45      final Map<Object, InputLocation> locations;
46      /** Location tracking */
47      final InputLocation importedFrom;
48  
49      /**
50        * Constructor for this class, to be called from its subclasses and {@link Builder}.
51        * @see Builder#build()
52        */
53      protected Exclusion(Builder builder) {
54          this.groupId = builder.groupId != null ? builder.groupId : (builder.base != null ? builder.base.groupId : null);
55          this.artifactId = builder.artifactId != null ? builder.artifactId : (builder.base != null ? builder.base.artifactId : null);
56          this.locations = builder.computeLocations();
57          this.importedFrom = builder.importedFrom;
58      }
59  
60      /**
61       * The group ID of the project to exclude.
62       *
63       * @return a {@code String}
64       */
65      public String getGroupId() {
66          return this.groupId;
67      }
68  
69      /**
70       * The artifact ID of the project to exclude.
71       *
72       * @return a {@code String}
73       */
74      public String getArtifactId() {
75          return this.artifactId;
76      }
77  
78      /**
79       * Gets the location of the specified field in the input source.
80       */
81      public InputLocation getLocation(Object key) {
82          return locations.get(key);
83      }
84  
85      /**
86       * Gets the keys of the locations of the input source.
87       */
88      public Set<Object> getLocationKeys() {
89          return locations.keySet();
90      }
91  
92      protected Stream<Object> getLocationKeyStream() {
93          return locations.keySet().stream();
94      }
95  
96      /**
97       * Gets the input location that caused this model to be read.
98       */
99      public InputLocation getImportedFrom()
100     {
101         return importedFrom;
102     }
103 
104     /**
105      * Creates a new builder with this object as the basis.
106      *
107      * @return a {@code Builder}
108      */
109     @Nonnull
110     public Builder with() {
111         return newBuilder(this);
112     }
113     /**
114      * Creates a new {@code Exclusion} instance using the specified groupId.
115      *
116      * @param groupId the new {@code String} to use
117      * @return a {@code Exclusion} with the specified groupId
118      */
119     @Nonnull
120     public Exclusion withGroupId(String groupId) {
121         return newBuilder(this, true).groupId(groupId).build();
122     }
123     /**
124      * Creates a new {@code Exclusion} instance using the specified artifactId.
125      *
126      * @param artifactId the new {@code String} to use
127      * @return a {@code Exclusion} with the specified artifactId
128      */
129     @Nonnull
130     public Exclusion withArtifactId(String artifactId) {
131         return newBuilder(this, true).artifactId(artifactId).build();
132     }
133 
134     /**
135      * Creates a new {@code Exclusion} instance.
136      * Equivalent to {@code newInstance(true)}.
137      * @see #newInstance(boolean)
138      *
139      * @return a new {@code Exclusion}
140      */
141     @Nonnull
142     public static Exclusion newInstance() {
143         return newInstance(true);
144     }
145 
146     /**
147      * Creates a new {@code Exclusion} instance using default values or not.
148      * Equivalent to {@code newBuilder(withDefaults).build()}.
149      *
150      * @param withDefaults the boolean indicating whether default values should be used
151      * @return a new {@code Exclusion}
152      */
153     @Nonnull
154     public static Exclusion newInstance(boolean withDefaults) {
155         return newBuilder(withDefaults).build();
156     }
157 
158     /**
159      * Creates a new {@code Exclusion} builder instance.
160      * Equivalent to {@code newBuilder(true)}.
161      * @see #newBuilder(boolean)
162      *
163      * @return a new {@code Builder}
164      */
165     @Nonnull
166     public static Builder newBuilder() {
167         return newBuilder(true);
168     }
169 
170     /**
171      * Creates a new {@code Exclusion} builder instance using default values or not.
172      *
173      * @param withDefaults the boolean indicating whether default values should be used
174      * @return a new {@code Builder}
175      */
176     @Nonnull
177     public static Builder newBuilder(boolean withDefaults) {
178         return new Builder(withDefaults);
179     }
180 
181     /**
182      * Creates a new {@code Exclusion} builder instance using the specified object as a basis.
183      * Equivalent to {@code newBuilder(from, false)}.
184      *
185      * @param from the {@code Exclusion} instance to use as a basis
186      * @return a new {@code Builder}
187      */
188     @Nonnull
189     public static Builder newBuilder(Exclusion from) {
190         return newBuilder(from, false);
191     }
192 
193     /**
194      * Creates a new {@code Exclusion} builder instance using the specified object as a basis.
195      *
196      * @param from the {@code Exclusion} instance to use as a basis
197      * @param forceCopy the boolean indicating if a copy should be forced
198      * @return a new {@code Builder}
199      */
200     @Nonnull
201     public static Builder newBuilder(Exclusion from, boolean forceCopy) {
202         return new Builder(from, forceCopy);
203     }
204 
205     /**
206      * Builder class used to create Exclusion instances.
207      * @see #with()
208      * @see #newBuilder()
209      */
210     @NotThreadSafe
211     public static class Builder
212     {
213         Exclusion base;
214         String groupId;
215         String artifactId;
216         Map<Object, InputLocation> locations;
217         InputLocation importedFrom;
218 
219         protected Builder(boolean withDefaults) {
220             if (withDefaults) {
221             }
222         }
223 
224         protected Builder(Exclusion base, boolean forceCopy) {
225             if (forceCopy) {
226                 this.groupId = base.groupId;
227                 this.artifactId = base.artifactId;
228                 this.locations = base.locations;
229                 this.importedFrom = base.importedFrom;
230             } else {
231                 this.base = base;
232             }
233         }
234 
235         @Nonnull
236         public Builder groupId(String groupId) {
237             this.groupId = groupId;
238             return this;
239         }
240 
241         @Nonnull
242         public Builder artifactId(String artifactId) {
243             this.artifactId = artifactId;
244             return this;
245         }
246 
247 
248         @Nonnull
249         public Builder location(Object key, InputLocation location) {
250             if (location != null) {
251                 if (!(this.locations instanceof HashMap)) {
252                     this.locations = this.locations != null ? new HashMap<>(this.locations) : new HashMap<>();
253                 }
254                 this.locations.put(key, location);
255             }
256             return this;
257         }
258 
259         @Nonnull
260         public Builder importedFrom(InputLocation importedFrom) {
261             this.importedFrom = importedFrom;
262             return this;
263         }
264 
265         @Nonnull
266         public Exclusion build() {
267             // this method should not contain any logic other than creating (or reusing) an object in order to ease subclassing
268             if (base != null
269                     && (groupId == null || groupId == base.groupId)
270                     && (artifactId == null || artifactId == base.artifactId)
271             ) {
272                 return base;
273             }
274             return new Exclusion(this);
275         }
276 
277         Map<Object, InputLocation> computeLocations() {
278             Map<Object, InputLocation> newlocs = locations != null ? locations : Map.of();
279             Map<Object, InputLocation> oldlocs = base != null ? base.locations : Map.of();
280             if (newlocs.isEmpty()) {
281                 return Map.copyOf(oldlocs);
282             }
283             if (oldlocs.isEmpty()) {
284                 return Map.copyOf(newlocs);
285             }
286             return Stream.concat(newlocs.entrySet().stream(), oldlocs.entrySet().stream())
287                     // Keep value from newlocs in case of duplicates
288                     .collect(Collectors.toUnmodifiableMap(Map.Entry::getKey, Map.Entry::getValue, (v1, v2) -> v1));
289         }
290     }
291 
292 }