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.ArrayList;
9   import java.util.Collection;
10  import java.util.Collections;
11  import java.util.HashMap;
12  import java.util.List;
13  import java.util.Map;
14  import java.util.Objects;
15  import java.util.Optional;
16  import java.util.Set;
17  import java.util.stream.Collectors;
18  import java.util.stream.Stream;
19  import org.apache.maven.api.annotations.Experimental;
20  import org.apache.maven.api.annotations.Generated;
21  import org.apache.maven.api.annotations.Immutable;
22  import org.apache.maven.api.annotations.Nonnull;
23  import org.apache.maven.api.annotations.NotThreadSafe;
24  import org.apache.maven.api.annotations.ThreadSafe;
25  
26  /**
27   * Section for management of reports and their configuration.
28   */
29  @Experimental
30  @Generated @ThreadSafe @Immutable
31  public class Reporting
32      implements Serializable, InputLocationTracker
33  {
34      /**
35       * If true, then the default reports are not included in the site generation.
36       * This includes the reports in the "Project Info" menu. Note: While the type
37       * of this field is {@code String} for technical reasons, the semantic type is actually
38       * {@code Boolean}. Default value is {@code false}.
39       */
40      final String excludeDefaults;
41      /**
42       * Where to store all the generated reports. The default is
43       * {@code ${project.build.directory}/site}.
44       */
45      final String outputDirectory;
46      /**
47       * The reporting plugins to use and their configuration.
48       */
49      final List<ReportPlugin> plugins;
50      /** Locations */
51      final Map<Object, InputLocation> locations;
52      /** Location tracking */
53      final InputLocation importedFrom;
54  
55      /**
56        * Constructor for this class, to be called from its subclasses and {@link Builder}.
57        * @see Builder#build()
58        */
59      protected Reporting(Builder builder) {
60          this.excludeDefaults = builder.excludeDefaults != null ? builder.excludeDefaults : (builder.base != null ? builder.base.excludeDefaults : null);
61          this.outputDirectory = builder.outputDirectory != null ? builder.outputDirectory : (builder.base != null ? builder.base.outputDirectory : null);
62          this.plugins = ImmutableCollections.copy(builder.plugins != null ? builder.plugins : (builder.base != null ? builder.base.plugins : null));
63          this.locations = builder.computeLocations();
64          this.importedFrom = builder.importedFrom;
65      }
66  
67      /**
68       * If true, then the default reports are not included in the site generation.
69       * This includes the reports in the "Project Info" menu. Note: While the type
70       * of this field is {@code String} for technical reasons, the semantic type is actually
71       * {@code Boolean}. Default value is {@code false}.
72       *
73       * @return a {@code String}
74       */
75      public String getExcludeDefaults() {
76          return this.excludeDefaults;
77      }
78  
79      /**
80       * Where to store all the generated reports. The default is
81       * {@code ${project.build.directory}/site}.
82       *
83       * @return a {@code String}
84       */
85      public String getOutputDirectory() {
86          return this.outputDirectory;
87      }
88  
89      /**
90       * The reporting plugins to use and their configuration.
91       *
92       * @return a {@code List<ReportPlugin>}
93       */
94      @Nonnull
95      public List<ReportPlugin> getPlugins() {
96          return this.plugins;
97      }
98  
99      /**
100      * Gets the location of the specified field in the input source.
101      */
102     public InputLocation getLocation(Object key) {
103         return locations.get(key);
104     }
105 
106     /**
107      * Gets the keys of the locations of the input source.
108      */
109     public Set<Object> getLocationKeys() {
110         return locations.keySet();
111     }
112 
113     protected Stream<Object> getLocationKeyStream() {
114         return locations.keySet().stream();
115     }
116 
117     /**
118      * Gets the input location that caused this model to be read.
119      */
120     public InputLocation getImportedFrom() {
121         return importedFrom;
122     }
123 
124     /**
125      * Creates a new builder with this object as the basis.
126      *
127      * @return a {@code Builder}
128      */
129     @Nonnull
130     public Builder with() {
131         return newBuilder(this);
132     }
133     /**
134      * Creates a new {@code Reporting} instance using the specified excludeDefaults.
135      *
136      * @param excludeDefaults the new {@code String} to use
137      * @return a {@code Reporting} with the specified excludeDefaults
138      */
139     @Nonnull
140     public Reporting withExcludeDefaults(String excludeDefaults) {
141         return newBuilder(this, true).excludeDefaults(excludeDefaults).build();
142     }
143     /**
144      * Creates a new {@code Reporting} instance using the specified outputDirectory.
145      *
146      * @param outputDirectory the new {@code String} to use
147      * @return a {@code Reporting} with the specified outputDirectory
148      */
149     @Nonnull
150     public Reporting withOutputDirectory(String outputDirectory) {
151         return newBuilder(this, true).outputDirectory(outputDirectory).build();
152     }
153     /**
154      * Creates a new {@code Reporting} instance using the specified plugins.
155      *
156      * @param plugins the new {@code Collection<ReportPlugin>} to use
157      * @return a {@code Reporting} with the specified plugins
158      */
159     @Nonnull
160     public Reporting withPlugins(Collection<ReportPlugin> plugins) {
161         return newBuilder(this, true).plugins(plugins).build();
162     }
163 
164     /**
165      * Creates a new {@code Reporting} instance.
166      * Equivalent to {@code newInstance(true)}.
167      * @see #newInstance(boolean)
168      *
169      * @return a new {@code Reporting}
170      */
171     @Nonnull
172     public static Reporting newInstance() {
173         return newInstance(true);
174     }
175 
176     /**
177      * Creates a new {@code Reporting} instance using default values or not.
178      * Equivalent to {@code newBuilder(withDefaults).build()}.
179      *
180      * @param withDefaults the boolean indicating whether default values should be used
181      * @return a new {@code Reporting}
182      */
183     @Nonnull
184     public static Reporting newInstance(boolean withDefaults) {
185         return newBuilder(withDefaults).build();
186     }
187 
188     /**
189      * Creates a new {@code Reporting} builder instance.
190      * Equivalent to {@code newBuilder(true)}.
191      * @see #newBuilder(boolean)
192      *
193      * @return a new {@code Builder}
194      */
195     @Nonnull
196     public static Builder newBuilder() {
197         return newBuilder(true);
198     }
199 
200     /**
201      * Creates a new {@code Reporting} builder instance using default values or not.
202      *
203      * @param withDefaults the boolean indicating whether default values should be used
204      * @return a new {@code Builder}
205      */
206     @Nonnull
207     public static Builder newBuilder(boolean withDefaults) {
208         return new Builder(withDefaults);
209     }
210 
211     /**
212      * Creates a new {@code Reporting} builder instance using the specified object as a basis.
213      * Equivalent to {@code newBuilder(from, false)}.
214      *
215      * @param from the {@code Reporting} instance to use as a basis
216      * @return a new {@code Builder}
217      */
218     @Nonnull
219     public static Builder newBuilder(Reporting from) {
220         return newBuilder(from, false);
221     }
222 
223     /**
224      * Creates a new {@code Reporting} builder instance using the specified object as a basis.
225      *
226      * @param from the {@code Reporting} instance to use as a basis
227      * @param forceCopy the boolean indicating if a copy should be forced
228      * @return a new {@code Builder}
229      */
230     @Nonnull
231     public static Builder newBuilder(Reporting from, boolean forceCopy) {
232         return new Builder(from, forceCopy);
233     }
234 
235     /**
236      * Builder class used to create Reporting instances.
237      * @see #with()
238      * @see #newBuilder()
239      */
240     @NotThreadSafe
241     public static class Builder
242     {
243         Reporting base;
244         String excludeDefaults;
245         String outputDirectory;
246         Collection<ReportPlugin> plugins;
247         Map<Object, InputLocation> locations;
248         InputLocation importedFrom;
249 
250         protected Builder(boolean withDefaults) {
251             if (withDefaults) {
252             }
253         }
254 
255         protected Builder(Reporting base, boolean forceCopy) {
256             if (forceCopy) {
257                 this.excludeDefaults = base.excludeDefaults;
258                 this.outputDirectory = base.outputDirectory;
259                 this.plugins = base.plugins;
260                 this.locations = base.locations;
261                 this.importedFrom = base.importedFrom;
262             } else {
263                 this.base = base;
264             }
265         }
266 
267         @Nonnull
268         public Builder excludeDefaults(String excludeDefaults) {
269             this.excludeDefaults = excludeDefaults;
270             return this;
271         }
272 
273         @Nonnull
274         public Builder outputDirectory(String outputDirectory) {
275             this.outputDirectory = outputDirectory;
276             return this;
277         }
278 
279         @Nonnull
280         public Builder plugins(Collection<ReportPlugin> plugins) {
281             this.plugins = plugins;
282             return this;
283         }
284 
285 
286         @Nonnull
287         public Builder location(Object key, InputLocation location) {
288             if (location != null) {
289                 if (!(this.locations instanceof HashMap)) {
290                     this.locations = this.locations != null ? new HashMap<>(this.locations) : new HashMap<>();
291                 }
292                 this.locations.put(key, location);
293             }
294             return this;
295         }
296 
297         @Nonnull
298         public Builder importedFrom(InputLocation importedFrom) {
299             this.importedFrom = importedFrom;
300             return this;
301         }
302 
303         @Nonnull
304         public Reporting build() {
305             // this method should not contain any logic other than creating (or reusing) an object in order to ease subclassing
306             if (base != null
307                     && (excludeDefaults == null || excludeDefaults == base.excludeDefaults)
308                     && (outputDirectory == null || outputDirectory == base.outputDirectory)
309                     && (plugins == null || plugins == base.plugins)
310             ) {
311                 return base;
312             }
313             return new Reporting(this);
314         }
315 
316         Map<Object, InputLocation> computeLocations() {
317             Map<Object, InputLocation> newlocs = locations != null ? locations : Map.of();
318             Map<Object, InputLocation> oldlocs = base != null ? base.locations : Map.of();
319             if (newlocs.isEmpty()) {
320                 return Map.copyOf(oldlocs);
321             }
322             if (oldlocs.isEmpty()) {
323                 return Map.copyOf(newlocs);
324             }
325             return Stream.concat(newlocs.entrySet().stream(), oldlocs.entrySet().stream())
326                     // Keep value from newlocs in case of duplicates
327                     .collect(Collectors.toUnmodifiableMap(Map.Entry::getKey, Map.Entry::getValue, (v1, v2) -> v1));
328         }
329     }
330 
331 
332             
333     public boolean isExcludeDefaults() {
334         return (getExcludeDefaults() != null) ? Boolean.parseBoolean(getExcludeDefaults()) : false;
335     }
336 
337             
338           
339 }