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