Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.eric.match.rev180730.icmpv6.nd.options.type.grouping

Class Icmpv6NdOptionsTypeValuesBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.eric.match.rev180730.icmpv6.nd.options.type.grouping.Icmpv6NdOptionsTypeValuesBuilder

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

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

   
     Icmpv6NdOptionsTypeValues createIcmpv6NdOptionsTypeValues(int fooXyzzy, int barBaz) {
         return new Icmpv6NdOptionsTypeValuesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• Icmpv6NdOptionsTypeValues

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Icmpv6NdOptionsTypeValuesBuilder

public Icmpv6NdOptionsTypeValuesBuilder()

Construct an empty builder.

Icmpv6NdOptionsTypeValuesBuilder

public Icmpv6NdOptionsTypeValuesBuilder(Icmpv6NdOptionsTypeValues base)

Construct a builder initialized with state from specified Icmpv6NdOptionsTypeValues.

Parameters:

base - Icmpv6NdOptionsTypeValues from which the builder should be initialized

Method Details

getIcmpv6NdOptionsType

public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv6NdOptionsType()

Return current value associated with the property corresponding to Icmpv6NdOptionsTypeValues.getIcmpv6NdOptionsType().

Returns:

current value

augmentation

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

setIcmpv6NdOptionsType

public Icmpv6NdOptionsTypeValuesBuilder setIcmpv6NdOptionsType(org.opendaylight.yangtools.yang.common.Uint8 value)

Set the property corresponding to Icmpv6NdOptionsTypeValues.getIcmpv6NdOptionsType() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new Icmpv6NdOptionsTypeValues instance.

Returns:

A new Icmpv6NdOptionsTypeValues instance.