Class LinkCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.LinkCaseBuilder
-
@Generated("mdsal-binding-generator") public class LinkCaseBuilder extends Object
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
- 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 LinkCaseBuilder()
Construct an empty builder.LinkCaseBuilder(LinkCase base)
Construct a builder initialized with state from specifiedLinkCase
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull LinkCase
build()
A newLinkCase
instance.LinkDescriptors
getLinkDescriptors()
Return current value associated with the property corresponding toLinkCase.getLinkDescriptors()
.LocalNodeDescriptors
getLocalNodeDescriptors()
Return current value associated with the property corresponding toLinkCase.getLocalNodeDescriptors()
.RemoteNodeDescriptors
getRemoteNodeDescriptors()
Return current value associated with the property corresponding toLinkCase.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)
Set the property corresponding toLinkCase.getLinkDescriptors()
to the specified value.LinkCaseBuilder
setLocalNodeDescriptors(LocalNodeDescriptors value)
Set the property corresponding toLinkCase.getLocalNodeDescriptors()
to the specified value.LinkCaseBuilder
setRemoteNodeDescriptors(RemoteNodeDescriptors value)
Set the property corresponding toLinkCase.getRemoteNodeDescriptors()
to the specified value.
-
-
-
Method Detail
-
getLinkDescriptors
public LinkDescriptors getLinkDescriptors()
Return current value associated with the property corresponding toLinkCase.getLinkDescriptors()
.- Returns:
- current value
-
getLocalNodeDescriptors
public LocalNodeDescriptors getLocalNodeDescriptors()
Return current value associated with the property corresponding toLinkCase.getLocalNodeDescriptors()
.- Returns:
- current value
-
getRemoteNodeDescriptors
public RemoteNodeDescriptors getRemoteNodeDescriptors()
Return current value associated with the property corresponding toLinkCase.getRemoteNodeDescriptors()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkCase>> 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
-
setLinkDescriptors
public LinkCaseBuilder setLinkDescriptors(LinkDescriptors value)
Set the property corresponding toLinkCase.getLinkDescriptors()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalNodeDescriptors
public LinkCaseBuilder setLocalNodeDescriptors(LocalNodeDescriptors value)
Set the property corresponding toLinkCase.getLocalNodeDescriptors()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemoteNodeDescriptors
public LinkCaseBuilder setRemoteNodeDescriptors(RemoteNodeDescriptors value)
Set the property corresponding toLinkCase.getRemoteNodeDescriptors()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-