Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416.vlan.logical.match.top.match

Class SingleTaggedRangeBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416.vlan.logical.match.top.match.SingleTaggedRangeBuilder

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

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

   
     SingleTaggedRange createSingleTaggedRange(int fooXyzzy, int barBaz) {
         return new SingleTaggedRangeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

SingleTaggedRange

Constructor Summary

Constructors

Constructor	Description
SingleTaggedRangeBuilder()	Construct an empty builder.
SingleTaggedRangeBuilder(SingleTaggedRange base)	Construct a builder initialized with state from specified SingleTaggedRange.

Method Summary

Modifier and Type	Method	Description
SingleTaggedRangeBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SingleTaggedRange> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SingleTaggedRange>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull SingleTaggedRange	build()	A new SingleTaggedRange instance.
Config	getConfig()	Return current value associated with the property corresponding to SingleTaggedRange.getConfig().
State	getState()	Return current value associated with the property corresponding to SingleTaggedRange.getState().
SingleTaggedRangeBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SingleTaggedRange>> augmentationType)	Remove an augmentation from this builder's product.
SingleTaggedRangeBuilder	setConfig(Config value)	Set the property corresponding to SingleTaggedRange.getConfig() to the specified value.
SingleTaggedRangeBuilder	setState(State value)	Set the property corresponding to SingleTaggedRange.getState() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleTaggedRangeBuilder

public SingleTaggedRangeBuilder()

Construct an empty builder.

SingleTaggedRangeBuilder

public SingleTaggedRangeBuilder(SingleTaggedRange base)

Construct a builder initialized with state from specified SingleTaggedRange.

Parameters:

base - SingleTaggedRange from which the builder should be initialized

Method Detail

getConfig

public Config getConfig()

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

Returns:

current value

getState

public State getState()

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

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SingleTaggedRange>> 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

setConfig

public SingleTaggedRangeBuilder setConfig(Config value)

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

Parameters:

value - desired value

Returns:

this builder

setState

public SingleTaggedRangeBuilder setState(State value)

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

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new SingleTaggedRange instance.

Returns:

A new SingleTaggedRange instance.