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

Class EricOfIcmpv6NdOptionsTypeBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.eric.match.rev180730.eric.of.icmpv6.nd.options.type.grouping.EricOfIcmpv6NdOptionsTypeBuilder

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

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

   
     EricOfIcmpv6NdOptionsType createEricOfIcmpv6NdOptionsType(int fooXyzzy, int barBaz) {
         return new EricOfIcmpv6NdOptionsTypeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

EricOfIcmpv6NdOptionsType

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EricOfIcmpv6NdOptionsTypeBuilder

public EricOfIcmpv6NdOptionsTypeBuilder()

Construct an empty builder.

EricOfIcmpv6NdOptionsTypeBuilder

public EricOfIcmpv6NdOptionsTypeBuilder(EricOfIcmpv6NdOptionsType base)

Construct a builder initialized with state from specified EricOfIcmpv6NdOptionsType.

Parameters:

base - EricOfIcmpv6NdOptionsType from which the builder should be initialized

Method Detail

getIcmpv6NdOptionsType

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

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

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EricOfIcmpv6NdOptionsType>> 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 EricOfIcmpv6NdOptionsTypeBuilder setIcmpv6NdOptionsType(org.opendaylight.yangtools.yang.common.Uint8 value)

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

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new EricOfIcmpv6NdOptionsType instance.

Returns:

A new EricOfIcmpv6NdOptionsType instance.