Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.user.error.spec
Class SubobjectsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.user.error.spec.SubobjectsBuilder
Class that builds
Subobjects
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:
Subobjects createSubobjects(int fooXyzzy, int barBaz) {
return new SubobjectsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Subobjects, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.SubobjectsBuilder
(Subobjects base) Construct a builder initialized with state from specifiedSubobjects
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Subobjects> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobjects>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Subobjects
build()
A newSubobjects
instance.static @NonNull Subobjects
empty()
Get empty instance of Subobjects.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobjects>> augmentationType) Remove an augmentation from this builder's product.
-
Constructor Details
-
SubobjectsBuilder
public SubobjectsBuilder()Construct an empty builder. -
SubobjectsBuilder
Construct a builder initialized with state from specifiedSubobjects
.- Parameters:
base
- Subobjects from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Subobjects.- Returns:
- An empty
Subobjects
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobjects>> 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
-
addAugmentation
public SubobjectsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Subobjects> 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 SubobjectsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobjects>> 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
-
build
A newSubobjects
instance.- Returns:
- A new
Subobjects
instance.
-