Class IgpBitsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.prefix.state.IgpBitsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IgpBits>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IgpBits,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IgpBitsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IgpBits>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description IgpBitsBuilder()
IgpBitsBuilder(IgpBits arg)
IgpBitsBuilder(IgpBits base)
-
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)
IgpBits
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIsIsUpDown()
Boolean
getOspfLocalAddress()
Boolean
getOspfNoUnicast()
Boolean
getOspfPropagateNssa()
IgpBits.UpDown
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)
IgpBitsBuilder
setOspfLocalAddress(Boolean value)
IgpBitsBuilder
setOspfNoUnicast(Boolean value)
IgpBitsBuilder
setOspfPropagateNssa(Boolean value)
IgpBitsBuilder
setUpDown(IgpBits.UpDown value)
-
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.IgpBits
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIsIsUpDown
public Boolean getIsIsUpDown()
-
getOspfLocalAddress
public Boolean getOspfLocalAddress()
-
getOspfNoUnicast
public Boolean getOspfNoUnicast()
-
getOspfPropagateNssa
public Boolean getOspfPropagateNssa()
-
getUpDown
public IgpBits.UpDown getUpDown()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpBits>> E$$ augmentation(Class<E$$> augmentationType)
-
setIsIsUpDown
public IgpBitsBuilder setIsIsUpDown(Boolean value)
-
setOspfLocalAddress
public IgpBitsBuilder setOspfLocalAddress(Boolean value)
-
setOspfNoUnicast
public IgpBitsBuilder setOspfNoUnicast(Boolean value)
-
setOspfPropagateNssa
public IgpBitsBuilder setOspfPropagateNssa(Boolean value)
-
setUpDown
public IgpBitsBuilder setUpDown(IgpBits.UpDown value)
-
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
-
build
public IgpBits build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IgpBits>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IgpBits,IllegalArgumentException>
-
-