Class SubobjectContainerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.explicit.route.subobjects.list.SubobjectContainerBuilder
-
@Generated("mdsal-binding-generator") public class SubobjectContainerBuilder extends Object
Class that buildsSubobjectContainer
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:
SubobjectContainer createSubobjectContainer(int fooXyzzy, int barBaz) { return new SubobjectContainerBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubobjectContainer, 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:
SubobjectContainer
- 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 SubobjectContainerBuilder()
Construct an empty builder.SubobjectContainerBuilder(BasicExplicitRouteSubobjects arg)
Construct a new builder initialized from specifiedBasicExplicitRouteSubobjects
.SubobjectContainerBuilder(SubobjectContainer base)
Construct a builder initialized with state from specifiedSubobjectContainer
.SubobjectContainerBuilder(ExplicitRouteSubobjects arg)
Construct a new builder initialized from specifiedExplicitRouteSubobjects
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubobjectContainerBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SubobjectContainer
build()
A newSubobjectContainer
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getLoose()
Return current value associated with the property corresponding toSubobjectContainer.getLoose()
.SubobjectType
getSubobjectType()
Return current value associated with the property corresponding toBasicExplicitRouteSubobjects.getSubobjectType()
.SubobjectContainerBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> augmentationType)
Remove an augmentation from this builder's product.SubobjectContainerBuilder
setLoose(Boolean value)
Set the property corresponding toSubobjectContainer.getLoose()
to the specified value.SubobjectContainerBuilder
setSubobjectType(SubobjectType value)
Set the property corresponding toBasicExplicitRouteSubobjects.getSubobjectType()
to the specified value.
-
-
-
Constructor Detail
-
SubobjectContainerBuilder
public SubobjectContainerBuilder()
Construct an empty builder.
-
SubobjectContainerBuilder
public SubobjectContainerBuilder(ExplicitRouteSubobjects arg)
Construct a new builder initialized from specifiedExplicitRouteSubobjects
.- Parameters:
arg
- ExplicitRouteSubobjects from which the builder should be initialized
-
SubobjectContainerBuilder
public SubobjectContainerBuilder(BasicExplicitRouteSubobjects arg)
Construct a new builder initialized from specifiedBasicExplicitRouteSubobjects
.- Parameters:
arg
- BasicExplicitRouteSubobjects from which the builder should be initialized
-
SubobjectContainerBuilder
public SubobjectContainerBuilder(SubobjectContainer base)
Construct a builder initialized with state from specifiedSubobjectContainer
.- Parameters:
base
- SubobjectContainer from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLoose
public Boolean getLoose()
Return current value associated with the property corresponding toSubobjectContainer.getLoose()
.- Returns:
- current value
-
getSubobjectType
public SubobjectType getSubobjectType()
Return current value associated with the property corresponding toBasicExplicitRouteSubobjects.getSubobjectType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> 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
-
setLoose
public SubobjectContainerBuilder setLoose(Boolean value)
Set the property corresponding toSubobjectContainer.getLoose()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSubobjectType
public SubobjectContainerBuilder setSubobjectType(SubobjectType value)
Set the property corresponding toBasicExplicitRouteSubobjects.getSubobjectType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SubobjectContainerBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer> 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 SubobjectContainerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> 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
public @NonNull SubobjectContainer build()
A newSubobjectContainer
instance.- Returns:
- A new
SubobjectContainer
instance.
-
-