Class IgpBitsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.prefix.state.IgpBitsBuilder
-
@Generated("mdsal-binding-generator") public class IgpBitsBuilder extends Object
Class that buildsIgpBits
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:
IgpBits createIgpBits(int fooXyzzy, int barBaz) { return new IgpBitsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IgpBits, 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:
IgpBits
- 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 IgpBitsBuilder()
Construct an empty builder.IgpBitsBuilder(IgpBits arg)
Construct a new builder initialized from specifiedIgpBits
.IgpBitsBuilder(IgpBits base)
Construct a builder initialized with state from specifiedIgpBits
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IgpBitsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpBits> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpBits>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull IgpBits
build()
A newIgpBits
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIsIsUpDown()
Return current value associated with the property corresponding toIgpBits.getIsIsUpDown()
.Boolean
getOspfLocalAddress()
Return current value associated with the property corresponding toIgpBits.getOspfLocalAddress()
.Boolean
getOspfNoUnicast()
Return current value associated with the property corresponding toIgpBits.getOspfNoUnicast()
.Boolean
getOspfPropagateNssa()
Return current value associated with the property corresponding toIgpBits.getOspfPropagateNssa()
.IgpBits.UpDown
getUpDown()
Return current value associated with the property corresponding toIgpBits.getUpDown()
.IgpBitsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpBits>> augmentationType)
Remove an augmentation from this builder's product.IgpBitsBuilder
setIsIsUpDown(Boolean value)
Set the property corresponding toIgpBits.getIsIsUpDown()
to the specified value.IgpBitsBuilder
setOspfLocalAddress(Boolean value)
Set the property corresponding toIgpBits.getOspfLocalAddress()
to the specified value.IgpBitsBuilder
setOspfNoUnicast(Boolean value)
Set the property corresponding toIgpBits.getOspfNoUnicast()
to the specified value.IgpBitsBuilder
setOspfPropagateNssa(Boolean value)
Set the property corresponding toIgpBits.getOspfPropagateNssa()
to the specified value.IgpBitsBuilder
setUpDown(IgpBits.UpDown value)
Set the property corresponding toIgpBits.getUpDown()
to the specified value.
-
-
-
Constructor Detail
-
IgpBitsBuilder
public IgpBitsBuilder()
Construct an empty builder.
-
IgpBitsBuilder
public IgpBitsBuilder(IgpBits arg)
Construct a new builder initialized from specifiedIgpBits
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.IgpBits from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIsIsUpDown
public Boolean getIsIsUpDown()
Return current value associated with the property corresponding toIgpBits.getIsIsUpDown()
.- Returns:
- current value
-
getOspfLocalAddress
public Boolean getOspfLocalAddress()
Return current value associated with the property corresponding toIgpBits.getOspfLocalAddress()
.- Returns:
- current value
-
getOspfNoUnicast
public Boolean getOspfNoUnicast()
Return current value associated with the property corresponding toIgpBits.getOspfNoUnicast()
.- Returns:
- current value
-
getOspfPropagateNssa
public Boolean getOspfPropagateNssa()
Return current value associated with the property corresponding toIgpBits.getOspfPropagateNssa()
.- Returns:
- current value
-
getUpDown
public IgpBits.UpDown getUpDown()
Return current value associated with the property corresponding toIgpBits.getUpDown()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpBits>> 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
-
setIsIsUpDown
public IgpBitsBuilder setIsIsUpDown(Boolean value)
Set the property corresponding toIgpBits.getIsIsUpDown()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfLocalAddress
public IgpBitsBuilder setOspfLocalAddress(Boolean value)
Set the property corresponding toIgpBits.getOspfLocalAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfNoUnicast
public IgpBitsBuilder setOspfNoUnicast(Boolean value)
Set the property corresponding toIgpBits.getOspfNoUnicast()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfPropagateNssa
public IgpBitsBuilder setOspfPropagateNssa(Boolean value)
Set the property corresponding toIgpBits.getOspfPropagateNssa()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpDown
public IgpBitsBuilder setUpDown(IgpBits.UpDown value)
Set the property corresponding toIgpBits.getUpDown()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IgpBitsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpBits> 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 IgpBitsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpBits>> 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
-
-