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.settings;
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   * This is an activator which will detect an operating system's attributes in order to activate
25   * its profile.
26   */
27  @Experimental
28  @Generated @ThreadSafe @Immutable
29  public class ActivationOS
30      implements Serializable, InputLocationTracker
31  {
32      /**
33       * The name of the OS to be used to activate a profile.
34       */
35      final String name;
36      /**
37       * The general family of the OS to be used to activate a profile (e.g. 'windows')
38       */
39      final String family;
40      /**
41       * The architecture of the OS to be used to activate a profile.
42       */
43      final String arch;
44      /**
45       * The version of the OS to be used to activate a profile.
46       */
47      final String version;
48      /** Locations */
49      final Map<Object, InputLocation> locations;
50      /** Location tracking */
51      final InputLocation importedFrom;
52  
53      /**
54        * Constructor for this class, to be called from its subclasses and {@link Builder}.
55        * @see Builder#build()
56        */
57      protected ActivationOS(Builder builder) {
58          this.name = builder.name != null ? builder.name : (builder.base != null ? builder.base.name : null);
59          this.family = builder.family != null ? builder.family : (builder.base != null ? builder.base.family : null);
60          this.arch = builder.arch != null ? builder.arch : (builder.base != null ? builder.base.arch : null);
61          this.version = builder.version != null ? builder.version : (builder.base != null ? builder.base.version : null);
62          this.locations = builder.computeLocations();
63          this.importedFrom = builder.importedFrom;
64      }
65  
66      /**
67       * The name of the OS to be used to activate a profile.
68       *
69       * @return a {@code String}
70       */
71      public String getName() {
72          return this.name;
73      }
74  
75      /**
76       * The general family of the OS to be used to activate a profile (e.g. 'windows')
77       *
78       * @return a {@code String}
79       */
80      public String getFamily() {
81          return this.family;
82      }
83  
84      /**
85       * The architecture of the OS to be used to activate a profile.
86       *
87       * @return a {@code String}
88       */
89      public String getArch() {
90          return this.arch;
91      }
92  
93      /**
94       * The version of the OS to be used to activate a profile.
95       *
96       * @return a {@code String}
97       */
98      public String getVersion() {
99          return this.version;
100     }
101 
102     /**
103      * Gets the location of the specified field in the input source.
104      */
105     public InputLocation getLocation(Object key) {
106         return locations.get(key);
107     }
108 
109     /**
110      * Gets the keys of the locations of the input source.
111      */
112     public Set<Object> getLocationKeys() {
113         return locations.keySet();
114     }
115 
116     protected Stream<Object> getLocationKeyStream() {
117         return locations.keySet().stream();
118     }
119 
120     /**
121      * Gets the input location that caused this model to be read.
122      */
123     public InputLocation getImportedFrom() {
124         return importedFrom;
125     }
126 
127     /**
128      * Creates a new builder with this object as the basis.
129      *
130      * @return a {@code Builder}
131      */
132     @Nonnull
133     public Builder with() {
134         return newBuilder(this);
135     }
136     /**
137      * Creates a new {@code ActivationOS} instance using the specified name.
138      *
139      * @param name the new {@code String} to use
140      * @return a {@code ActivationOS} with the specified name
141      */
142     @Nonnull
143     public ActivationOS withName(String name) {
144         return newBuilder(this, true).name(name).build();
145     }
146     /**
147      * Creates a new {@code ActivationOS} instance using the specified family.
148      *
149      * @param family the new {@code String} to use
150      * @return a {@code ActivationOS} with the specified family
151      */
152     @Nonnull
153     public ActivationOS withFamily(String family) {
154         return newBuilder(this, true).family(family).build();
155     }
156     /**
157      * Creates a new {@code ActivationOS} instance using the specified arch.
158      *
159      * @param arch the new {@code String} to use
160      * @return a {@code ActivationOS} with the specified arch
161      */
162     @Nonnull
163     public ActivationOS withArch(String arch) {
164         return newBuilder(this, true).arch(arch).build();
165     }
166     /**
167      * Creates a new {@code ActivationOS} instance using the specified version.
168      *
169      * @param version the new {@code String} to use
170      * @return a {@code ActivationOS} with the specified version
171      */
172     @Nonnull
173     public ActivationOS withVersion(String version) {
174         return newBuilder(this, true).version(version).build();
175     }
176 
177     /**
178      * Creates a new {@code ActivationOS} instance.
179      * Equivalent to {@code newInstance(true)}.
180      * @see #newInstance(boolean)
181      *
182      * @return a new {@code ActivationOS}
183      */
184     @Nonnull
185     public static ActivationOS newInstance() {
186         return newInstance(true);
187     }
188 
189     /**
190      * Creates a new {@code ActivationOS} instance using default values or not.
191      * Equivalent to {@code newBuilder(withDefaults).build()}.
192      *
193      * @param withDefaults the boolean indicating whether default values should be used
194      * @return a new {@code ActivationOS}
195      */
196     @Nonnull
197     public static ActivationOS newInstance(boolean withDefaults) {
198         return newBuilder(withDefaults).build();
199     }
200 
201     /**
202      * Creates a new {@code ActivationOS} builder instance.
203      * Equivalent to {@code newBuilder(true)}.
204      * @see #newBuilder(boolean)
205      *
206      * @return a new {@code Builder}
207      */
208     @Nonnull
209     public static Builder newBuilder() {
210         return newBuilder(true);
211     }
212 
213     /**
214      * Creates a new {@code ActivationOS} builder instance using default values or not.
215      *
216      * @param withDefaults the boolean indicating whether default values should be used
217      * @return a new {@code Builder}
218      */
219     @Nonnull
220     public static Builder newBuilder(boolean withDefaults) {
221         return new Builder(withDefaults);
222     }
223 
224     /**
225      * Creates a new {@code ActivationOS} builder instance using the specified object as a basis.
226      * Equivalent to {@code newBuilder(from, false)}.
227      *
228      * @param from the {@code ActivationOS} instance to use as a basis
229      * @return a new {@code Builder}
230      */
231     @Nonnull
232     public static Builder newBuilder(ActivationOS from) {
233         return newBuilder(from, false);
234     }
235 
236     /**
237      * Creates a new {@code ActivationOS} builder instance using the specified object as a basis.
238      *
239      * @param from the {@code ActivationOS} instance to use as a basis
240      * @param forceCopy the boolean indicating if a copy should be forced
241      * @return a new {@code Builder}
242      */
243     @Nonnull
244     public static Builder newBuilder(ActivationOS from, boolean forceCopy) {
245         return new Builder(from, forceCopy);
246     }
247 
248     /**
249      * Builder class used to create ActivationOS instances.
250      * @see #with()
251      * @see #newBuilder()
252      */
253     @NotThreadSafe
254     public static class Builder
255     {
256         ActivationOS base;
257         String name;
258         String family;
259         String arch;
260         String version;
261         Map<Object, InputLocation> locations;
262         InputLocation importedFrom;
263 
264         protected Builder(boolean withDefaults) {
265             if (withDefaults) {
266             }
267         }
268 
269         protected Builder(ActivationOS base, boolean forceCopy) {
270             if (forceCopy) {
271                 this.name = base.name;
272                 this.family = base.family;
273                 this.arch = base.arch;
274                 this.version = base.version;
275                 this.locations = base.locations;
276                 this.importedFrom = base.importedFrom;
277             } else {
278                 this.base = base;
279             }
280         }
281 
282         @Nonnull
283         public Builder name(String name) {
284             this.name = name;
285             return this;
286         }
287 
288         @Nonnull
289         public Builder family(String family) {
290             this.family = family;
291             return this;
292         }
293 
294         @Nonnull
295         public Builder arch(String arch) {
296             this.arch = arch;
297             return this;
298         }
299 
300         @Nonnull
301         public Builder version(String version) {
302             this.version = version;
303             return this;
304         }
305 
306 
307         @Nonnull
308         public Builder location(Object key, InputLocation location) {
309             if (location != null) {
310                 if (!(this.locations instanceof HashMap)) {
311                     this.locations = this.locations != null ? new HashMap<>(this.locations) : new HashMap<>();
312                 }
313                 this.locations.put(key, location);
314             }
315             return this;
316         }
317 
318         @Nonnull
319         public Builder importedFrom(InputLocation importedFrom) {
320             this.importedFrom = importedFrom;
321             return this;
322         }
323 
324         @Nonnull
325         public ActivationOS build() {
326             // this method should not contain any logic other than creating (or reusing) an object in order to ease subclassing
327             if (base != null
328                     && (name == null || name == base.name)
329                     && (family == null || family == base.family)
330                     && (arch == null || arch == base.arch)
331                     && (version == null || version == base.version)
332             ) {
333                 return base;
334             }
335             return new ActivationOS(this);
336         }
337 
338         Map<Object, InputLocation> computeLocations() {
339             Map<Object, InputLocation> newlocs = locations != null ? locations : Map.of();
340             Map<Object, InputLocation> oldlocs = base != null ? base.locations : Map.of();
341             if (newlocs.isEmpty()) {
342                 return Map.copyOf(oldlocs);
343             }
344             if (oldlocs.isEmpty()) {
345                 return Map.copyOf(newlocs);
346             }
347             return Stream.concat(newlocs.entrySet().stream(), oldlocs.entrySet().stream())
348                     // Keep value from newlocs in case of duplicates
349                     .collect(Collectors.toUnmodifiableMap(Map.Entry::getKey, Map.Entry::getValue, (v1, v2) -> v1));
350         }
351     }
352 
353 }