Class AfiSafiBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.afi.safi.route.counter.AfiSafiBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AfiSafi>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AfiSafi,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AfiSafiBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AfiSafi>
Class that buildsAfiSafiBuilder
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:
AfiSafiBuilder createTarget(int fooXyzzy, int barBaz) { return new AfiSafiBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AfiSafiBuilder, 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 oportunities, 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:
AfiSafiBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AfiSafiBuilder()
AfiSafiBuilder(BgpTableType arg)
AfiSafiBuilder(AfiSafi base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AfiSafiBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafi> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafi>>
E$$augmentation(Class<E$$> augmentationType)
AfiSafi
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends AddressFamily>
getAfi()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64
getCount()
Class<? extends SubsequentAddressFamily>
getSafi()
AfiSafiKey
key()
AfiSafiBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafi>> augmentationType)
Remove an augmentation from this builder's product.AfiSafiBuilder
setAfi(Class<? extends AddressFamily> value)
AfiSafiBuilder
setCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 value)
AfiSafiBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
AfiSafiBuilder
withKey(AfiSafiKey key)
-
-
-
Constructor Detail
-
AfiSafiBuilder
public AfiSafiBuilder()
-
AfiSafiBuilder
public AfiSafiBuilder(BgpTableType arg)
-
AfiSafiBuilder
public AfiSafiBuilder(AfiSafi base)
-
-
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.multiprotocol.rev180329.BgpTableType
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public AfiSafiKey key()
-
getAfi
public Class<? extends AddressFamily> getAfi()
-
getCount
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 getCount()
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafi>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public AfiSafiBuilder withKey(AfiSafiKey key)
-
setAfi
public AfiSafiBuilder setAfi(Class<? extends AddressFamily> value)
-
setCount
public AfiSafiBuilder setCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 value)
-
setSafi
public AfiSafiBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
-
addAugmentation
public AfiSafiBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafi> 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 AfiSafiBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafi>> 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 AfiSafi build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AfiSafi>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AfiSafi,IllegalArgumentException>
-
-