Class SecondaryExplicitRouteObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.object.SecondaryExplicitRouteObjectBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SecondaryExplicitRouteObject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SecondaryExplicitRouteObject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SecondaryExplicitRouteObjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SecondaryExplicitRouteObject>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description SecondaryExplicitRouteObjectBuilder()
SecondaryExplicitRouteObjectBuilder(RsvpTeObject arg)
SecondaryExplicitRouteObjectBuilder(SecondaryExplicitRouteObject base)
-
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)
SecondaryExplicitRouteObject
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<SubobjectContainer>
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)
-
-
-
Constructor Detail
-
SecondaryExplicitRouteObjectBuilder
public SecondaryExplicitRouteObjectBuilder()
-
SecondaryExplicitRouteObjectBuilder
public SecondaryExplicitRouteObjectBuilder(RsvpTeObject arg)
-
SecondaryExplicitRouteObjectBuilder
public SecondaryExplicitRouteObjectBuilder(SecondaryExplicitRouteObject base)
-
-
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:- RsvpTeObject
- 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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SecondaryExplicitRouteObject>> E$$ augmentation(Class<E$$> augmentationType)
-
setSubobjectContainer
public SecondaryExplicitRouteObjectBuilder setSubobjectContainer(List<SubobjectContainer> values)
-
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 SecondaryExplicitRouteObject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SecondaryExplicitRouteObject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SecondaryExplicitRouteObject,IllegalArgumentException>
-
-