Class LinkstateRoutesCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.bgp.rib.rib.loc.rib.tables.routes.LinkstateRoutesCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LinkstateRoutesCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LinkstateRoutesCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LinkstateRoutesCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LinkstateRoutesCase>
Class that buildsLinkstateRoutesCase
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:
LinkstateRoutesCase createLinkstateRoutesCase(int fooXyzzy, int barBaz) { return new LinkstateRoutesCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LinkstateRoutesCase, 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:
LinkstateRoutesCase
,Builder
-
-
Constructor Summary
Constructors Constructor Description LinkstateRoutesCaseBuilder()
LinkstateRoutesCaseBuilder(LinkstateRoutesCase base)
LinkstateRoutesCaseBuilder(LinkstateRoutes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LinkstateRoutesCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoutesCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoutesCase>>
E$$augmentation(Class<E$$> augmentationType)
LinkstateRoutesCase
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.LinkstateRoutes
getLinkstateRoutes()
LinkstateRoutesCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoutesCase>> augmentationType)
Remove an augmentation from this builder's product.LinkstateRoutesCaseBuilder
setLinkstateRoutes(LinkstateRoutes value)
-
-
-
Constructor Detail
-
LinkstateRoutesCaseBuilder
public LinkstateRoutesCaseBuilder()
-
LinkstateRoutesCaseBuilder
public LinkstateRoutesCaseBuilder(LinkstateRoutes arg)
-
LinkstateRoutesCaseBuilder
public LinkstateRoutesCaseBuilder(LinkstateRoutesCase 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.LinkstateRoutes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLinkstateRoutes
public LinkstateRoutes getLinkstateRoutes()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoutesCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setLinkstateRoutes
public LinkstateRoutesCaseBuilder setLinkstateRoutes(LinkstateRoutes value)
-
addAugmentation
public LinkstateRoutesCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoutesCase> 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 LinkstateRoutesCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoutesCase>> 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 LinkstateRoutesCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LinkstateRoutesCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LinkstateRoutesCase,IllegalArgumentException>
-
-