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