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.plugin.descriptor;
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.Set;
12 import org.apache.maven.api.annotations.Experimental;
13 import org.apache.maven.api.annotations.Generated;
14 import org.apache.maven.api.annotations.Immutable;
15 import org.apache.maven.api.annotations.Nonnull;
16 import org.apache.maven.api.annotations.NotThreadSafe;
17 import org.apache.maven.api.annotations.ThreadSafe;
18
19 /**
20 * Dependency collection or resolution injection.
21 */
22 @Experimental
23 @Generated @ThreadSafe @Immutable
24 public class Resolution
25 implements Serializable
26 {
27 /**
28 * the name of the field to be injected
29 */
30 final String field;
31 /**
32 * pathScope used to flatten dependencies
33 */
34 final String pathScope;
35 /**
36 * either {@code collect}, {@code flatten}, or {@code resolve}
37 */
38 final String requestType;
39
40 /**
41 * Constructor for this class, to be called from its subclasses and {@link Builder}.
42 * @see Builder#build()
43 */
44 protected Resolution(Builder builder) {
45 this.field = builder.field != null ? builder.field : (builder.base != null ? builder.base.field : null);
46 this.pathScope = builder.pathScope != null ? builder.pathScope : (builder.base != null ? builder.base.pathScope : null);
47 this.requestType = builder.requestType != null ? builder.requestType : (builder.base != null ? builder.base.requestType : null);
48 }
49
50 /**
51 * the name of the field to be injected
52 *
53 * @return a {@code String}
54 */
55 public String getField() {
56 return this.field;
57 }
58
59 /**
60 * pathScope used to flatten dependencies
61 *
62 * @return a {@code String}
63 */
64 public String getPathScope() {
65 return this.pathScope;
66 }
67
68 /**
69 * either {@code collect}, {@code flatten}, or {@code resolve}
70 *
71 * @return a {@code String}
72 */
73 public String getRequestType() {
74 return this.requestType;
75 }
76
77 /**
78 * Creates a new builder with this object as the basis.
79 *
80 * @return a {@code Builder}
81 */
82 @Nonnull
83 public Builder with() {
84 return newBuilder(this);
85 }
86 /**
87 * Creates a new {@code Resolution} instance using the specified field.
88 *
89 * @param field the new {@code String} to use
90 * @return a {@code Resolution} with the specified field
91 */
92 @Nonnull
93 public Resolution withField(String field) {
94 return newBuilder(this, true).field(field).build();
95 }
96 /**
97 * Creates a new {@code Resolution} instance using the specified pathScope.
98 *
99 * @param pathScope the new {@code String} to use
100 * @return a {@code Resolution} with the specified pathScope
101 */
102 @Nonnull
103 public Resolution withPathScope(String pathScope) {
104 return newBuilder(this, true).pathScope(pathScope).build();
105 }
106 /**
107 * Creates a new {@code Resolution} instance using the specified requestType.
108 *
109 * @param requestType the new {@code String} to use
110 * @return a {@code Resolution} with the specified requestType
111 */
112 @Nonnull
113 public Resolution withRequestType(String requestType) {
114 return newBuilder(this, true).requestType(requestType).build();
115 }
116
117 /**
118 * Creates a new {@code Resolution} instance.
119 * Equivalent to {@code newInstance(true)}.
120 * @see #newInstance(boolean)
121 *
122 * @return a new {@code Resolution}
123 */
124 @Nonnull
125 public static Resolution newInstance() {
126 return newInstance(true);
127 }
128
129 /**
130 * Creates a new {@code Resolution} instance using default values or not.
131 * Equivalent to {@code newBuilder(withDefaults).build()}.
132 *
133 * @param withDefaults the boolean indicating whether default values should be used
134 * @return a new {@code Resolution}
135 */
136 @Nonnull
137 public static Resolution newInstance(boolean withDefaults) {
138 return newBuilder(withDefaults).build();
139 }
140
141 /**
142 * Creates a new {@code Resolution} builder instance.
143 * Equivalent to {@code newBuilder(true)}.
144 * @see #newBuilder(boolean)
145 *
146 * @return a new {@code Builder}
147 */
148 @Nonnull
149 public static Builder newBuilder() {
150 return newBuilder(true);
151 }
152
153 /**
154 * Creates a new {@code Resolution} builder instance using default values or not.
155 *
156 * @param withDefaults the boolean indicating whether default values should be used
157 * @return a new {@code Builder}
158 */
159 @Nonnull
160 public static Builder newBuilder(boolean withDefaults) {
161 return new Builder(withDefaults);
162 }
163
164 /**
165 * Creates a new {@code Resolution} builder instance using the specified object as a basis.
166 * Equivalent to {@code newBuilder(from, false)}.
167 *
168 * @param from the {@code Resolution} instance to use as a basis
169 * @return a new {@code Builder}
170 */
171 @Nonnull
172 public static Builder newBuilder(Resolution from) {
173 return newBuilder(from, false);
174 }
175
176 /**
177 * Creates a new {@code Resolution} builder instance using the specified object as a basis.
178 *
179 * @param from the {@code Resolution} instance to use as a basis
180 * @param forceCopy the boolean indicating if a copy should be forced
181 * @return a new {@code Builder}
182 */
183 @Nonnull
184 public static Builder newBuilder(Resolution from, boolean forceCopy) {
185 return new Builder(from, forceCopy);
186 }
187
188 /**
189 * Builder class used to create Resolution instances.
190 * @see #with()
191 * @see #newBuilder()
192 */
193 @NotThreadSafe
194 public static class Builder
195 {
196 Resolution base;
197 String field;
198 String pathScope;
199 String requestType;
200
201 protected Builder(boolean withDefaults) {
202 if (withDefaults) {
203 }
204 }
205
206 protected Builder(Resolution base, boolean forceCopy) {
207 if (forceCopy) {
208 this.field = base.field;
209 this.pathScope = base.pathScope;
210 this.requestType = base.requestType;
211 } else {
212 this.base = base;
213 }
214 }
215
216 @Nonnull
217 public Builder field(String field) {
218 this.field = field;
219 return this;
220 }
221
222 @Nonnull
223 public Builder pathScope(String pathScope) {
224 this.pathScope = pathScope;
225 return this;
226 }
227
228 @Nonnull
229 public Builder requestType(String requestType) {
230 this.requestType = requestType;
231 return this;
232 }
233
234
235 @Nonnull
236 public Resolution build() {
237 // this method should not contain any logic other than creating (or reusing) an object in order to ease subclassing
238 if (base != null
239 && (field == null || field == base.field)
240 && (pathScope == null || pathScope == base.pathScope)
241 && (requestType == null || requestType == base.requestType)
242 ) {
243 return base;
244 }
245 return new Resolution(this);
246 }
247 }
248
249 }