Class SecondaryExplicitRouteObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.object.SecondaryExplicitRouteObjectBuilder
-
@Generated("mdsal-binding-generator") public class SecondaryExplicitRouteObjectBuilder extends Object
Class that buildsSecondaryExplicitRouteObject
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:
SecondaryExplicitRouteObject createSecondaryExplicitRouteObject(int fooXyzzy, int barBaz) { return new SecondaryExplicitRouteObjectBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SecondaryExplicitRouteObject, 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:
SecondaryExplicitRouteObject
- 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 SecondaryExplicitRouteObjectBuilder()
Construct an empty builder.SecondaryExplicitRouteObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.SecondaryExplicitRouteObjectBuilder(SecondaryExplicitRouteObject base)
Construct a builder initialized with state from specifiedSecondaryExplicitRouteObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SecondaryExplicitRouteObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SecondaryExplicitRouteObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SecondaryExplicitRouteObject>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SecondaryExplicitRouteObject
build()
A newSecondaryExplicitRouteObject
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<SubobjectContainer>
getSubobjectContainer()
Return current value associated with the property corresponding toSecondaryExplicitRouteObject.getSubobjectContainer()
.SecondaryExplicitRouteObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SecondaryExplicitRouteObject>> augmentationType)
Remove an augmentation from this builder's product.SecondaryExplicitRouteObjectBuilder
setSubobjectContainer(List<SubobjectContainer> values)
Set the property corresponding toSecondaryExplicitRouteObject.getSubobjectContainer()
to the specified value.
-
-
-
Constructor Detail
-
SecondaryExplicitRouteObjectBuilder
public SecondaryExplicitRouteObjectBuilder()
Construct an empty builder.
-
SecondaryExplicitRouteObjectBuilder
public SecondaryExplicitRouteObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.- Parameters:
arg
- RsvpTeObject from which the builder should be initialized
-
SecondaryExplicitRouteObjectBuilder
public SecondaryExplicitRouteObjectBuilder(SecondaryExplicitRouteObject base)
Construct a builder initialized with state from specifiedSecondaryExplicitRouteObject
.- Parameters:
base
- SecondaryExplicitRouteObject 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
-
getSubobjectContainer
public List<SubobjectContainer> getSubobjectContainer()
Return current value associated with the property corresponding toSecondaryExplicitRouteObject.getSubobjectContainer()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SecondaryExplicitRouteObject>> 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
-
setSubobjectContainer
public SecondaryExplicitRouteObjectBuilder setSubobjectContainer(List<SubobjectContainer> values)
Set the property corresponding toSecondaryExplicitRouteObject.getSubobjectContainer()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SecondaryExplicitRouteObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SecondaryExplicitRouteObject> 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 SecondaryExplicitRouteObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SecondaryExplicitRouteObject>> 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 SecondaryExplicitRouteObject build()
A newSecondaryExplicitRouteObject
instance.- Returns:
- A new
SecondaryExplicitRouteObject
instance.
-
-