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