Class OspfTopologyAttributesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.network.topology.topology.igp.topology.attributes.OspfTopologyAttributesBuilder
-
@Generated("mdsal-binding-generator") public class OspfTopologyAttributesBuilder extends Object
Class that buildsOspfTopologyAttributes
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:
OspfTopologyAttributes createOspfTopologyAttributes(int fooXyzzy, int barBaz) { return new OspfTopologyAttributesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfTopologyAttributes, 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:
OspfTopologyAttributes
- 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 OspfTopologyAttributesBuilder()
Construct an empty builder.OspfTopologyAttributesBuilder(OspfTopologyAttributes base)
Construct a builder initialized with state from specifiedOspfTopologyAttributes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OspfTopologyAttributesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfTopologyAttributes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfTopologyAttributes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull OspfTopologyAttributes
build()
A newOspfTopologyAttributes
instance.AreaId
getAreaId()
Return current value associated with the property corresponding toOspfTopologyAttributes.getAreaId()
.OspfTopologyAttributesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfTopologyAttributes>> augmentationType)
Remove an augmentation from this builder's product.OspfTopologyAttributesBuilder
setAreaId(AreaId value)
Set the property corresponding toOspfTopologyAttributes.getAreaId()
to the specified value.
-
-
-
Constructor Detail
-
OspfTopologyAttributesBuilder
public OspfTopologyAttributesBuilder()
Construct an empty builder.
-
OspfTopologyAttributesBuilder
public OspfTopologyAttributesBuilder(OspfTopologyAttributes base)
Construct a builder initialized with state from specifiedOspfTopologyAttributes
.- Parameters:
base
- OspfTopologyAttributes from which the builder should be initialized
-
-
Method Detail
-
getAreaId
public AreaId getAreaId()
Return current value associated with the property corresponding toOspfTopologyAttributes.getAreaId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfTopologyAttributes>> 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 OspfTopologyAttributesBuilder setAreaId(AreaId value)
Set the property corresponding toOspfTopologyAttributes.getAreaId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OspfTopologyAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfTopologyAttributes> 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 OspfTopologyAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfTopologyAttributes>> 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 OspfTopologyAttributes build()
A newOspfTopologyAttributes
instance.- Returns:
- A new
OspfTopologyAttributes
instance.
-
-