Class UserCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.rsvp.error.spec.tlv.rsvp.error.spec.error.type.UserCaseBuilder
-
@Generated("mdsal-binding-generator") public class UserCaseBuilder extends Object
Class that buildsUserCase
instances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
UserCase createUserCase(int fooXyzzy, int barBaz) { return new UserCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UserCase, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
UserCase
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
-
-
Constructor Summary
Constructors Constructor Description UserCaseBuilder()
Construct an empty builder.UserCaseBuilder(UserCase base)
Construct a builder initialized with state from specifiedUserCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UserCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UserCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UserCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UserCase
build()
A newUserCase
instance.UserError
getUserError()
Return current value associated with the property corresponding toUserCase.getUserError()
.UserCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserCase>> augmentationType)
Remove an augmentation from this builder's product.UserCaseBuilder
setUserError(UserError value)
Set the property corresponding toUserCase.getUserError()
to the specified value.
-
-
-
Method Detail
-
getUserError
public UserError getUserError()
Return current value associated with the property corresponding toUserCase.getUserError()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UserCase>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setUserError
public UserCaseBuilder setUserError(UserError value)
Set the property corresponding toUserCase.getUserError()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UserCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UserCase> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public UserCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserCase>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
-