Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.aggregate.rev200501

Class Config1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.aggregate.rev200501.Config1Builder

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

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

   
     Config1 createConfig1(int fooXyzzy, int barBaz) {
         return new Config1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

Config1

Constructor Summary

Constructors

Constructor	Description
Config1Builder()	Construct an empty builder.
Config1Builder(Config1 base)	Construct a builder initialized with state from specified Config1.
Config1Builder(EthernetIfAggregationConfig arg)	Construct a new builder initialized from specified EthernetIfAggregationConfig.

Method Summary

Modifier and Type	Method	Description
@NonNull Config1	build()	A new Config1 instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
String	getAggregateId()	Return current value associated with the property corresponding to EthernetIfAggregationConfig.getAggregateId().
Config1Builder	setAggregateId(String value)	Set the property corresponding to EthernetIfAggregationConfig.getAggregateId() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config1Builder

public Config1Builder()

Construct an empty builder.

Config1Builder

public Config1Builder(EthernetIfAggregationConfig arg)

Construct a new builder initialized from specified EthernetIfAggregationConfig.

Parameters:

arg - EthernetIfAggregationConfig from which the builder should be initialized

Config1Builder

public Config1Builder(Config1 base)

Construct a builder initialized with state from specified Config1.

Parameters:

base - Config1 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:

• EthernetIfAggregationConfig

Parameters:

arg - grouping object

Throws:

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

getAggregateId

public String getAggregateId()

Return current value associated with the property corresponding to EthernetIfAggregationConfig.getAggregateId().

Returns:

current value

setAggregateId

public Config1Builder setAggregateId(String value)

Set the property corresponding to EthernetIfAggregationConfig.getAggregateId() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull Config1 build()

A new Config1 instance.

Returns:

A new Config1 instance.