Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes
Class OspfNodeAttributesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.OspfNodeAttributesBuilder
Class that builds
OspfNodeAttributes
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:
OspfNodeAttributes createOspfNodeAttributes(int fooXyzzy, int barBaz) {
return new OspfNodeAttributesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of OspfNodeAttributes, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedOspfNodeAttributes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<OspfNodeAttributes> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<OspfNodeAttributes>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull OspfNodeAttributes
build()
A newOspfNodeAttributes
instance.static @NonNull OspfNodeAttributes
empty()
Get empty instance of OspfNodeAttributes.Return current value associated with the property corresponding toOspfNodeAttributes.getCapabilities()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toOspfNodeAttributes.getDrInterfaceId()
.Set
<org.opendaylight.yangtools.yang.common.Uint8> Return current value associated with the property corresponding toOspfNodeAttributes.getMultiTopologyId()
.Return current value associated with the property corresponding toOspfNodeAttributes.getRouterType()
.getTed()
Return current value associated with the property corresponding toOspfNodeAttributes.getTed()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<OspfNodeAttributes>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toOspfNodeAttributes.getCapabilities()
to the specified value.setDrInterfaceId
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toOspfNodeAttributes.getDrInterfaceId()
to the specified value.setMultiTopologyId
(Set<org.opendaylight.yangtools.yang.common.Uint8> values) Set the property corresponding toOspfNodeAttributes.getMultiTopologyId()
to the specified value.setRouterType
(RouterType value) Set the property corresponding toOspfNodeAttributes.getRouterType()
to the specified value.Set the property corresponding toOspfNodeAttributes.getTed()
to the specified value.
-
Constructor Details
-
OspfNodeAttributesBuilder
public OspfNodeAttributesBuilder()Construct an empty builder. -
OspfNodeAttributesBuilder
Construct a builder initialized with state from specifiedOspfNodeAttributes
.- Parameters:
base
- OspfNodeAttributes from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of OspfNodeAttributes.- Returns:
- An empty
OspfNodeAttributes
-
getCapabilities
Return current value associated with the property corresponding toOspfNodeAttributes.getCapabilities()
.- Returns:
- current value
-
getDrInterfaceId
public org.opendaylight.yangtools.yang.common.Uint32 getDrInterfaceId()Return current value associated with the property corresponding toOspfNodeAttributes.getDrInterfaceId()
.- Returns:
- current value
-
getMultiTopologyId
Return current value associated with the property corresponding toOspfNodeAttributes.getMultiTopologyId()
.- Returns:
- current value
-
getRouterType
Return current value associated with the property corresponding toOspfNodeAttributes.getRouterType()
.- Returns:
- current value
-
getTed
Return current value associated with the property corresponding toOspfNodeAttributes.getTed()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<OspfNodeAttributes>> 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
-
setCapabilities
Set the property corresponding toOspfNodeAttributes.getCapabilities()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDrInterfaceId
public OspfNodeAttributesBuilder setDrInterfaceId(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toOspfNodeAttributes.getDrInterfaceId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMultiTopologyId
public OspfNodeAttributesBuilder setMultiTopologyId(Set<org.opendaylight.yangtools.yang.common.Uint8> values) Set the property corresponding toOspfNodeAttributes.getMultiTopologyId()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setRouterType
Set the property corresponding toOspfNodeAttributes.getRouterType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTed
Set the property corresponding toOspfNodeAttributes.getTed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OspfNodeAttributesBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<OspfNodeAttributes> 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 OspfNodeAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<OspfNodeAttributes>> 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 newOspfNodeAttributes
instance.- Returns:
- A new
OspfNodeAttributes
instance.
-