Class NodeDescriptorsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.node._case.NodeDescriptorsBuilder
-
@Generated("mdsal-binding-generator") public class NodeDescriptorsBuilder extends Object
Class that buildsNodeDescriptors
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:
NodeDescriptors createNodeDescriptors(int fooXyzzy, int barBaz) { return new NodeDescriptorsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NodeDescriptors, 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:
NodeDescriptors
- 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 NodeDescriptorsBuilder()
Construct an empty builder.NodeDescriptorsBuilder(NodeDescriptors base)
Construct a builder initialized with state from specifiedNodeDescriptors
.NodeDescriptorsBuilder(NodeIdentifier arg)
Construct a new builder initialized from specifiedNodeIdentifier
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NodeDescriptorsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NodeDescriptors> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeDescriptors>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NodeDescriptors
build()
A newNodeDescriptors
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AreaIdentifier
getAreaId()
Return current value associated with the property corresponding toNodeIdentifier.getAreaId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getAsNumber()
Return current value associated with the property corresponding toNodeIdentifier.getAsNumber()
.CRouterIdentifier
getCRouterIdentifier()
Return current value associated with the property corresponding toNodeIdentifier.getCRouterIdentifier()
.DomainIdentifier
getDomainId()
Return current value associated with the property corresponding toNodeIdentifier.getDomainId()
.NodeDescriptorsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeDescriptors>> augmentationType)
Remove an augmentation from this builder's product.NodeDescriptorsBuilder
setAreaId(AreaIdentifier value)
Set the property corresponding toNodeIdentifier.getAreaId()
to the specified value.NodeDescriptorsBuilder
setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toNodeIdentifier.getAsNumber()
to the specified value.NodeDescriptorsBuilder
setCRouterIdentifier(CRouterIdentifier value)
Set the property corresponding toNodeIdentifier.getCRouterIdentifier()
to the specified value.NodeDescriptorsBuilder
setDomainId(DomainIdentifier value)
Set the property corresponding toNodeIdentifier.getDomainId()
to the specified value.
-
-
-
Constructor Detail
-
NodeDescriptorsBuilder
public NodeDescriptorsBuilder()
Construct an empty builder.
-
NodeDescriptorsBuilder
public NodeDescriptorsBuilder(NodeIdentifier arg)
Construct a new builder initialized from specifiedNodeIdentifier
.- Parameters:
arg
- NodeIdentifier from which the builder should be initialized
-
NodeDescriptorsBuilder
public NodeDescriptorsBuilder(NodeDescriptors base)
Construct a builder initialized with state from specifiedNodeDescriptors
.- Parameters:
base
- NodeDescriptors 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
-
getAreaId
public AreaIdentifier getAreaId()
Return current value associated with the property corresponding toNodeIdentifier.getAreaId()
.- Returns:
- current value
-
getAsNumber
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAsNumber()
Return current value associated with the property corresponding toNodeIdentifier.getAsNumber()
.- Returns:
- current value
-
getCRouterIdentifier
public CRouterIdentifier getCRouterIdentifier()
Return current value associated with the property corresponding toNodeIdentifier.getCRouterIdentifier()
.- Returns:
- current value
-
getDomainId
public DomainIdentifier getDomainId()
Return current value associated with the property corresponding toNodeIdentifier.getDomainId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeDescriptors>> 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
-
setAreaId
public NodeDescriptorsBuilder setAreaId(AreaIdentifier value)
Set the property corresponding toNodeIdentifier.getAreaId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAsNumber
public NodeDescriptorsBuilder setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toNodeIdentifier.getAsNumber()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCRouterIdentifier
public NodeDescriptorsBuilder setCRouterIdentifier(CRouterIdentifier value)
Set the property corresponding toNodeIdentifier.getCRouterIdentifier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDomainId
public NodeDescriptorsBuilder setDomainId(DomainIdentifier value)
Set the property corresponding toNodeIdentifier.getDomainId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NodeDescriptorsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NodeDescriptors> 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 NodeDescriptorsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeDescriptors>> 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 NodeDescriptors build()
A newNodeDescriptors
instance.- Returns:
- A new
NodeDescriptors
instance.
-
-