Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.table.connections

Class TableConnectionBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.table.connections.TableConnectionBuilder

@Generated("mdsal-binding-generator")
public class TableConnectionBuilder
extends Object

Class that builds TableConnection 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:

   
     TableConnection createTableConnection(int fooXyzzy, int barBaz) {
         return new TableConnectionBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of TableConnection, 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:

• TableConnection

Constructor Summary

Constructors

Constructor	Description
TableConnectionBuilder()	Construct an empty builder.
TableConnectionBuilder(TableConnection base)	Construct a builder initialized with state from specified TableConnection.
TableConnectionBuilder(ApplyPolicyGroup arg)	Construct a new builder initialized from specified ApplyPolicyGroup.

Method Summary

Modifier and Type	Method	Description
TableConnectionBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableConnection> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableConnection>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull TableConnection	build()	A new TableConnection instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
ApplyPolicy	getApplyPolicy()	Return current value associated with the property corresponding to ApplyPolicyGroup.getApplyPolicy().
Config	getConfig()	Return current value associated with the property corresponding to TableConnection.getConfig().
String	getDstTable()	Return current value associated with the property corresponding to TableConnection.getDstTable().
String	getSrcTable()	Return current value associated with the property corresponding to TableConnection.getSrcTable().
State	getState()	Return current value associated with the property corresponding to TableConnection.getState().
TableConnectionKey	key()	Return current value associated with the property corresponding to TableConnection.key().
TableConnectionBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableConnection>> augmentationType)	Remove an augmentation from this builder's product.
TableConnectionBuilder	setApplyPolicy(ApplyPolicy value)	Set the property corresponding to ApplyPolicyGroup.getApplyPolicy() to the specified value.
TableConnectionBuilder	setConfig(Config value)	Set the property corresponding to TableConnection.getConfig() to the specified value.
TableConnectionBuilder	setDstTable(String value)	Set the property corresponding to TableConnection.getDstTable() to the specified value.
TableConnectionBuilder	setSrcTable(String value)	Set the property corresponding to TableConnection.getSrcTable() to the specified value.
TableConnectionBuilder	setState(State value)	Set the property corresponding to TableConnection.getState() to the specified value.
TableConnectionBuilder	withKey(TableConnectionKey key)	Set the key value corresponding to TableConnection.key() to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TableConnectionBuilder

public TableConnectionBuilder()

Construct an empty builder.

TableConnectionBuilder

public TableConnectionBuilder(ApplyPolicyGroup arg)

Construct a new builder initialized from specified ApplyPolicyGroup.

Parameters:

arg - ApplyPolicyGroup from which the builder should be initialized

TableConnectionBuilder

public TableConnectionBuilder(TableConnection base)

Construct a builder initialized with state from specified TableConnection.

Parameters:

base - TableConnection from which the builder should be initialized

Method Details

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:

• ApplyPolicyGroup

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

key

public TableConnectionKey key()

Return current value associated with the property corresponding to TableConnection.key().

Returns:

current value

getApplyPolicy

public ApplyPolicy getApplyPolicy()

Return current value associated with the property corresponding to ApplyPolicyGroup.getApplyPolicy().

Returns:

current value

getConfig

public Config getConfig()

Return current value associated with the property corresponding to TableConnection.getConfig().

Returns:

current value

getDstTable

public String getDstTable()

Return current value associated with the property corresponding to TableConnection.getDstTable().

Returns:

current value

getSrcTable

public String getSrcTable()

Return current value associated with the property corresponding to TableConnection.getSrcTable().

Returns:

current value

getState

public State getState()

Return current value associated with the property corresponding to TableConnection.getState().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableConnection>>
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 - if augmentType is null

withKey

public TableConnectionBuilder withKey(TableConnectionKey key)

Set the key value corresponding to TableConnection.key() to the specified value.

Parameters:

key - desired value

Returns:

this builder

setApplyPolicy

public TableConnectionBuilder setApplyPolicy(ApplyPolicy value)

Set the property corresponding to ApplyPolicyGroup.getApplyPolicy() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setConfig

public TableConnectionBuilder setConfig(Config value)

Set the property corresponding to TableConnection.getConfig() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setDstTable

public TableConnectionBuilder setDstTable(String value)

Set the property corresponding to TableConnection.getDstTable() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setSrcTable

public TableConnectionBuilder setSrcTable(String value)

Set the property corresponding to TableConnection.getSrcTable() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setState

public TableConnectionBuilder setState(State value)

Set the property corresponding to TableConnection.getState() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public TableConnectionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableConnection> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

public TableConnectionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableConnection>> 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 TableConnection build()

A new TableConnection instance.

Returns:

A new TableConnection instance.