Class TablesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.graceful.restart.capability.TablesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Tables>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Tables,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TablesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Tables>
Class that buildsTablesBuilder
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:
TablesBuilder createTarget(int fooXyzzy, int barBaz) { return new TablesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TablesBuilder, 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:
TablesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TablesBuilder()
TablesBuilder(BgpTableType arg)
TablesBuilder(Tables base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TablesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tables> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tables>>
E$$augmentation(Class<E$$> augmentationType)
Tables
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends AddressFamily>
getAfi()
Tables.AfiFlags
getAfiFlags()
Class<? extends SubsequentAddressFamily>
getSafi()
TablesKey
key()
TablesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tables>> augmentationType)
Remove an augmentation from this builder's product.TablesBuilder
setAfi(Class<? extends AddressFamily> value)
TablesBuilder
setAfiFlags(Tables.AfiFlags value)
TablesBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
TablesBuilder
withKey(TablesKey key)
-
-
-
Constructor Detail
-
TablesBuilder
public TablesBuilder()
-
TablesBuilder
public TablesBuilder(BgpTableType arg)
-
TablesBuilder
public TablesBuilder(Tables 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 TablesKey key()
-
getAfi
public Class<? extends AddressFamily> getAfi()
-
getAfiFlags
public Tables.AfiFlags getAfiFlags()
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tables>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public TablesBuilder withKey(TablesKey key)
-
setAfi
public TablesBuilder setAfi(Class<? extends AddressFamily> value)
-
setAfiFlags
public TablesBuilder setAfiFlags(Tables.AfiFlags value)
-
setSafi
public TablesBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
-
addAugmentation
public TablesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tables> 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 TablesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tables>> 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 Tables build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Tables>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Tables,IllegalArgumentException>
-
-