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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OspfNodeAttributes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OspfNodeAttributes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OspfNodeAttributesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OspfNodeAttributes>
Class that buildsOspfNodeAttributesBuilder
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:
OspfNodeAttributesBuilder createTarget(int fooXyzzy, int barBaz) { return new OspfNodeAttributesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfNodeAttributesBuilder, 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 oportunities, 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:
OspfNodeAttributesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OspfNodeAttributesBuilder()
OspfNodeAttributesBuilder(OspfNodeAttributes base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OspfNodeAttributesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfNodeAttributes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfNodeAttributes>>
E$$augmentation(Class<E$$> augmentationType)
OspfNodeAttributes
build()
OspfNodeAttributes.Capabilities
getCapabilities()
org.opendaylight.yangtools.yang.common.Uint32
getDrInterfaceId()
List<org.opendaylight.yangtools.yang.common.Uint8>
getMultiTopologyId()
RouterType
getRouterType()
Ted
getTed()
OspfNodeAttributesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfNodeAttributes>> augmentationType)
Remove an augmentation from this builder's product.OspfNodeAttributesBuilder
setCapabilities(OspfNodeAttributes.Capabilities value)
OspfNodeAttributesBuilder
setDrInterfaceId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDrInterfaceId(Uint32)
instead.OspfNodeAttributesBuilder
setDrInterfaceId(org.opendaylight.yangtools.yang.common.Uint32 value)
OspfNodeAttributesBuilder
setMultiTopologyId(List<org.opendaylight.yangtools.yang.common.Uint8> values)
OspfNodeAttributesBuilder
setRouterType(RouterType value)
OspfNodeAttributesBuilder
setTed(Ted value)
-
-
-
Constructor Detail
-
OspfNodeAttributesBuilder
public OspfNodeAttributesBuilder()
-
OspfNodeAttributesBuilder
public OspfNodeAttributesBuilder(OspfNodeAttributes base)
-
-
Method Detail
-
getCapabilities
public OspfNodeAttributes.Capabilities getCapabilities()
-
getDrInterfaceId
public org.opendaylight.yangtools.yang.common.Uint32 getDrInterfaceId()
-
getMultiTopologyId
public List<org.opendaylight.yangtools.yang.common.Uint8> getMultiTopologyId()
-
getRouterType
public RouterType getRouterType()
-
getTed
public Ted getTed()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfNodeAttributes>> E$$ augmentation(Class<E$$> augmentationType)
-
setCapabilities
public OspfNodeAttributesBuilder setCapabilities(OspfNodeAttributes.Capabilities value)
-
setDrInterfaceId
public OspfNodeAttributesBuilder setDrInterfaceId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDrInterfaceId
@Deprecated(forRemoval=true) public OspfNodeAttributesBuilder setDrInterfaceId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDrInterfaceId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMultiTopologyId
public OspfNodeAttributesBuilder setMultiTopologyId(List<org.opendaylight.yangtools.yang.common.Uint8> values)
-
setRouterType
public OspfNodeAttributesBuilder setRouterType(RouterType value)
-
setTed
public OspfNodeAttributesBuilder setTed(Ted value)
-
addAugmentation
public OspfNodeAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.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.yang.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
public OspfNodeAttributes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OspfNodeAttributes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OspfNodeAttributes,IllegalArgumentException>
-
-