Class LinkCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.LinkCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LinkCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LinkCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LinkCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LinkCase>
Class that buildsLinkCase
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:
LinkCase createLinkCase(int fooXyzzy, int barBaz) { return new LinkCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LinkCase, 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:
LinkCase
,Builder
-
-
Constructor Summary
Constructors Constructor Description LinkCaseBuilder()
LinkCaseBuilder(LinkCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LinkCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkCase>>
E$$augmentation(Class<E$$> augmentationType)
LinkCase
build()
LinkDescriptors
getLinkDescriptors()
LocalNodeDescriptors
getLocalNodeDescriptors()
RemoteNodeDescriptors
getRemoteNodeDescriptors()
LinkCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkCase>> augmentationType)
Remove an augmentation from this builder's product.LinkCaseBuilder
setLinkDescriptors(LinkDescriptors value)
LinkCaseBuilder
setLocalNodeDescriptors(LocalNodeDescriptors value)
LinkCaseBuilder
setRemoteNodeDescriptors(RemoteNodeDescriptors value)
-
-
-
Constructor Detail
-
LinkCaseBuilder
public LinkCaseBuilder()
-
LinkCaseBuilder
public LinkCaseBuilder(LinkCase base)
-
-
Method Detail
-
getLinkDescriptors
public LinkDescriptors getLinkDescriptors()
-
getLocalNodeDescriptors
public LocalNodeDescriptors getLocalNodeDescriptors()
-
getRemoteNodeDescriptors
public RemoteNodeDescriptors getRemoteNodeDescriptors()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setLinkDescriptors
public LinkCaseBuilder setLinkDescriptors(LinkDescriptors value)
-
setLocalNodeDescriptors
public LinkCaseBuilder setLocalNodeDescriptors(LocalNodeDescriptors value)
-
setRemoteNodeDescriptors
public LinkCaseBuilder setRemoteNodeDescriptors(RemoteNodeDescriptors value)
-
addAugmentation
public LinkCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkCase> 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 LinkCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkCase>> 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 LinkCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LinkCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LinkCase,IllegalArgumentException>
-
-