Class TablesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder
-
@Generated("mdsal-binding-generator") public class TablesBuilder extends Object
Class that buildsTables
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:
Tables createTables(int fooXyzzy, int barBaz) { return new TablesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Tables, 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:
Tables
- 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 TablesBuilder()
Construct an empty builder.TablesBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.TablesBuilder(Tables base)
Construct a builder initialized with state from specifiedTables
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull Tables
build()
A newTables
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends AddressFamily>
getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.Attributes
getAttributes()
Return current value associated with the property corresponding toTables.getAttributes()
.Routes
getRoutes()
Return current value associated with the property corresponding toTables.getRoutes()
.Class<? extends SubsequentAddressFamily>
getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.TablesKey
key()
Return current value associated with the property corresponding toTables.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)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.TablesBuilder
setAttributes(Attributes value)
Set the property corresponding toTables.getAttributes()
to the specified value.TablesBuilder
setRoutes(Routes value)
Set the property corresponding toTables.getRoutes()
to the specified value.TablesBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.TablesBuilder
withKey(TablesKey key)
-
-
-
Constructor Detail
-
TablesBuilder
public TablesBuilder()
Construct an empty builder.
-
TablesBuilder
public TablesBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.- Parameters:
arg
- BgpTableType 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
-
key
public TablesKey key()
Return current value associated with the property corresponding toTables.key()
.- Returns:
- current value
-
getAfi
public Class<? extends AddressFamily> getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.- Returns:
- current value
-
getAttributes
public Attributes getAttributes()
Return current value associated with the property corresponding toTables.getAttributes()
.- Returns:
- current value
-
getRoutes
public Routes getRoutes()
Return current value associated with the property corresponding toTables.getRoutes()
.- Returns:
- current value
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tables>> 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
-
withKey
public TablesBuilder withKey(TablesKey key)
-
setAfi
public TablesBuilder setAfi(Class<? extends AddressFamily> value)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAttributes
public TablesBuilder setAttributes(Attributes value)
Set the property corresponding toTables.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRoutes
public TablesBuilder setRoutes(Routes value)
Set the property corresponding toTables.getRoutes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSafi
public TablesBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-