Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.esi

Class MacAutoGeneratedCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.esi.MacAutoGeneratedCaseBuilder

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

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

   
     MacAutoGeneratedCase createMacAutoGeneratedCase(int fooXyzzy, int barBaz) {
         return new MacAutoGeneratedCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• MacAutoGeneratedCase

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

MacAutoGeneratedCaseBuilder

public MacAutoGeneratedCaseBuilder()

Construct an empty builder.

MacAutoGeneratedCaseBuilder

public MacAutoGeneratedCaseBuilder(MacAutoGeneratedCase base)

Construct a builder initialized with state from specified MacAutoGeneratedCase.

Parameters:

base - MacAutoGeneratedCase from which the builder should be initialized

Method Details

getMacAutoGenerated

public MacAutoGenerated getMacAutoGenerated()

Return current value associated with the property corresponding to MacAutoGeneratedCase.getMacAutoGenerated().

Returns:

current value

augmentation

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

setMacAutoGenerated

public MacAutoGeneratedCaseBuilder setMacAutoGenerated(MacAutoGenerated value)

Set the property corresponding to MacAutoGeneratedCase.getMacAutoGenerated() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new MacAutoGeneratedCase instance.

Returns:

A new MacAutoGeneratedCase instance.