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