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      {
96          return importedFrom;
97      }
98  
99      /**
100      * Creates a new builder with this object as the basis.
101      *
102      * @return a {@code Builder}
103      */
104     @Nonnull
105     public Builder with() {
106         return newBuilder(this);
107     }
108     /**
109      * Creates a new {@code Organization} instance using the specified name.
110      *
111      * @param name the new {@code String} to use
112      * @return a {@code Organization} with the specified name
113      */
114     @Nonnull
115     public Organization withName(String name) {
116         return newBuilder(this, true).name(name).build();
117     }
118     /**
119      * Creates a new {@code Organization} instance using the specified url.
120      *
121      * @param url the new {@code String} to use
122      * @return a {@code Organization} with the specified url
123      */
124     @Nonnull
125     public Organization withUrl(String url) {
126         return newBuilder(this, true).url(url).build();
127     }
128 
129     /**
130      * Creates a new {@code Organization} instance.
131      * Equivalent to {@code newInstance(true)}.
132      * @see #newInstance(boolean)
133      *
134      * @return a new {@code Organization}
135      */
136     @Nonnull
137     public static Organization newInstance() {
138         return newInstance(true);
139     }
140 
141     /**
142      * Creates a new {@code Organization} instance using default values or not.
143      * Equivalent to {@code newBuilder(withDefaults).build()}.
144      *
145      * @param withDefaults the boolean indicating whether default values should be used
146      * @return a new {@code Organization}
147      */
148     @Nonnull
149     public static Organization newInstance(boolean withDefaults) {
150         return newBuilder(withDefaults).build();
151     }
152 
153     /**
154      * Creates a new {@code Organization} builder instance.
155      * Equivalent to {@code newBuilder(true)}.
156      * @see #newBuilder(boolean)
157      *
158      * @return a new {@code Builder}
159      */
160     @Nonnull
161     public static Builder newBuilder() {
162         return newBuilder(true);
163     }
164 
165     /**
166      * Creates a new {@code Organization} builder instance using default values or not.
167      *
168      * @param withDefaults the boolean indicating whether default values should be used
169      * @return a new {@code Builder}
170      */
171     @Nonnull
172     public static Builder newBuilder(boolean withDefaults) {
173         return new Builder(withDefaults);
174     }
175 
176     /**
177      * Creates a new {@code Organization} builder instance using the specified object as a basis.
178      * Equivalent to {@code newBuilder(from, false)}.
179      *
180      * @param from the {@code Organization} instance to use as a basis
181      * @return a new {@code Builder}
182      */
183     @Nonnull
184     public static Builder newBuilder(Organization from) {
185         return newBuilder(from, false);
186     }
187 
188     /**
189      * Creates a new {@code Organization} builder instance using the specified object as a basis.
190      *
191      * @param from the {@code Organization} instance to use as a basis
192      * @param forceCopy the boolean indicating if a copy should be forced
193      * @return a new {@code Builder}
194      */
195     @Nonnull
196     public static Builder newBuilder(Organization from, boolean forceCopy) {
197         return new Builder(from, forceCopy);
198     }
199 
200     /**
201      * Builder class used to create Organization instances.
202      * @see #with()
203      * @see #newBuilder()
204      */
205     @NotThreadSafe
206     public static class Builder
207     {
208         Organization base;
209         String name;
210         String url;
211         Map<Object, InputLocation> locations;
212         InputLocation importedFrom;
213 
214         protected Builder(boolean withDefaults) {
215             if (withDefaults) {
216             }
217         }
218 
219         protected Builder(Organization base, boolean forceCopy) {
220             if (forceCopy) {
221                 this.name = base.name;
222                 this.url = base.url;
223                 this.locations = base.locations;
224                 this.importedFrom = base.importedFrom;
225             } else {
226                 this.base = base;
227             }
228         }
229 
230         @Nonnull
231         public Builder name(String name) {
232             this.name = name;
233             return this;
234         }
235 
236         @Nonnull
237         public Builder url(String url) {
238             this.url = url;
239             return this;
240         }
241 
242 
243         @Nonnull
244         public Builder location(Object key, InputLocation location) {
245             if (location != null) {
246                 if (!(this.locations instanceof HashMap)) {
247                     this.locations = this.locations != null ? new HashMap<>(this.locations) : new HashMap<>();
248                 }
249                 this.locations.put(key, location);
250             }
251             return this;
252         }
253 
254         @Nonnull
255         public Builder importedFrom(InputLocation importedFrom) {
256             this.importedFrom = importedFrom;
257             return this;
258         }
259 
260         @Nonnull
261         public Organization build() {
262             // this method should not contain any logic other than creating (or reusing) an object in order to ease subclassing
263             if (base != null
264                     && (name == null || name == base.name)
265                     && (url == null || url == base.url)
266             ) {
267                 return base;
268             }
269             return new Organization(this);
270         }
271 
272         Map<Object, InputLocation> computeLocations() {
273             Map<Object, InputLocation> newlocs = locations != null ? locations : Map.of();
274             Map<Object, InputLocation> oldlocs = base != null ? base.locations : Map.of();
275             if (newlocs.isEmpty()) {
276                 return Map.copyOf(oldlocs);
277             }
278             if (oldlocs.isEmpty()) {
279                 return Map.copyOf(newlocs);
280             }
281             return Stream.concat(newlocs.entrySet().stream(), oldlocs.entrySet().stream())
282                     // Keep value from newlocs in case of duplicates
283                     .collect(Collectors.toUnmodifiableMap(Map.Entry::getKey, Map.Entry::getValue, (v1, v2) -> v1));
284         }
285     }
286 
287 
288             
289     /**
290      * @see java.lang.Object#toString()
291      */
292     public String toString()
293     {
294         return "Organization {name=" + getName() + ", url=" + getUrl() + "}";
295     }
296             
297           
298 }