Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.peer
Class SupportedTablesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.peer.SupportedTablesBuilder
-
@Generated("mdsal-binding-generator") public class SupportedTablesBuilder extends Object
Class that buildsSupportedTables
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:
SupportedTables createSupportedTables(int fooXyzzy, int barBaz) { return new SupportedTablesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SupportedTables, 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:
SupportedTables
- 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 SupportedTablesBuilder()
Construct an empty builder.SupportedTablesBuilder(BgpAddPathTableType arg)
Construct a new builder initialized from specifiedBgpAddPathTableType
.SupportedTablesBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.SupportedTablesBuilder(SupportedTables base)
Construct a builder initialized with state from specifiedSupportedTables
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SupportedTablesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTables> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTables>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SupportedTables
build()
A newSupportedTables
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()
.Class<? extends SubsequentAddressFamily>
getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.SendReceive
getSendReceive()
Return current value associated with the property corresponding toBgpAddPathTableType.getSendReceive()
.SupportedTablesKey
key()
Return current value associated with the property corresponding toSupportedTables.key()
.SupportedTablesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTables>> augmentationType)
Remove an augmentation from this builder's product.SupportedTablesBuilder
setAfi(Class<? extends AddressFamily> value)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.SupportedTablesBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.SupportedTablesBuilder
setSendReceive(SendReceive value)
Set the property corresponding toBgpAddPathTableType.getSendReceive()
to the specified value.SupportedTablesBuilder
withKey(SupportedTablesKey key)
-
-
-
Constructor Detail
-
SupportedTablesBuilder
public SupportedTablesBuilder()
Construct an empty builder.
-
SupportedTablesBuilder
public SupportedTablesBuilder(BgpAddPathTableType arg)
Construct a new builder initialized from specifiedBgpAddPathTableType
.- Parameters:
arg
- BgpAddPathTableType from which the builder should be initialized
-
SupportedTablesBuilder
public SupportedTablesBuilder(BgpTableType arg)
Construct a new builder initialized from specifiedBgpTableType
.- Parameters:
arg
- BgpTableType from which the builder should be initialized
-
SupportedTablesBuilder
public SupportedTablesBuilder(SupportedTables base)
Construct a builder initialized with state from specifiedSupportedTables
.- Parameters:
base
- SupportedTables 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 SupportedTablesKey key()
Return current value associated with the property corresponding toSupportedTables.key()
.- Returns:
- current value
-
getAfi
public Class<? extends AddressFamily> getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.- Returns:
- current value
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.- Returns:
- current value
-
getSendReceive
public SendReceive getSendReceive()
Return current value associated with the property corresponding toBgpAddPathTableType.getSendReceive()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTables>> 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 SupportedTablesBuilder withKey(SupportedTablesKey key)
-
setAfi
public SupportedTablesBuilder setAfi(Class<? extends AddressFamily> value)
Set the property corresponding toBgpTableType.getAfi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSafi
public SupportedTablesBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
Set the property corresponding toBgpTableType.getSafi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSendReceive
public SupportedTablesBuilder setSendReceive(SendReceive value)
Set the property corresponding toBgpAddPathTableType.getSendReceive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SupportedTablesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTables> 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 SupportedTablesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTables>> 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 @NonNull SupportedTables build()
A newSupportedTables
instance.- Returns:
- A new
SupportedTables
instance.
-
-