Class OspfNodeBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.node.identifier.c.router.identifier.ospf.node._case.OspfNodeBuilder
Class that builds
OspfNode
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:
OspfNode createOspfNode(int fooXyzzy, int barBaz) {
return new OspfNodeBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of OspfNode, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.OspfNodeBuilder
(OspfNode base) Construct a builder initialized with state from specifiedOspfNode
.Construct a new builder initialized from specifiedOspfRouterIdentifier
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<OspfNode> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<OspfNode>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull OspfNode
build()
A newOspfNode
instance.static @NonNull OspfNode
empty()
Get empty instance of OspfNode.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toOspfRouterIdentifier.getOspfRouterId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<OspfNode>> augmentationType) Remove an augmentation from this builder's product.setOspfRouterId
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toOspfRouterIdentifier.getOspfRouterId()
to the specified value.
-
Constructor Details
-
OspfNodeBuilder
public OspfNodeBuilder()Construct an empty builder. -
OspfNodeBuilder
Construct a new builder initialized from specifiedOspfRouterIdentifier
.- Parameters:
arg
- OspfRouterIdentifier from which the builder should be initialized
-
OspfNodeBuilder
Construct a builder initialized with state from specifiedOspfNode
.- Parameters:
base
- OspfNode from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Get empty instance of OspfNode.- Returns:
- An empty
OspfNode
-
getOspfRouterId
public org.opendaylight.yangtools.yang.common.Uint32 getOspfRouterId()Return current value associated with the property corresponding toOspfRouterIdentifier.getOspfRouterId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<OspfNode>> 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
-
setOspfRouterId
Set the property corresponding toOspfRouterIdentifier.getOspfRouterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OspfNodeBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<OspfNode> 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 OspfNodeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<OspfNode>> 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
A newOspfNode
instance.- Returns:
- A new
OspfNode
instance.
-