Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes

Class InterfaceTypeEntryBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.InterfaceTypeEntryBuilder

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

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

   
     InterfaceTypeEntry createInterfaceTypeEntry(int fooXyzzy, int barBaz) {
         return new InterfaceTypeEntryBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• InterfaceTypeEntry

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

InterfaceTypeEntryBuilder

public InterfaceTypeEntryBuilder()

Construct an empty builder.

InterfaceTypeEntryBuilder

public InterfaceTypeEntryBuilder(InterfaceTypeEntry base)

Construct a builder initialized with state from specified InterfaceTypeEntry.

Parameters:

base - InterfaceTypeEntry from which the builder should be initialized

Method Details

key

public InterfaceTypeEntryKey key()

Return current value associated with the property corresponding to InterfaceTypeEntry.key().

Returns:

current value

getInterfaceType

public InterfaceTypeBase getInterfaceType()

Return current value associated with the property corresponding to InterfaceTypeEntry.getInterfaceType().

Returns:

current value

augmentation

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

withKey

public InterfaceTypeEntryBuilder withKey(InterfaceTypeEntryKey key)

Set the key value corresponding to InterfaceTypeEntry.key() to the specified value.

Parameters:

key - desired value

Returns:

this builder

setInterfaceType

public InterfaceTypeEntryBuilder setInterfaceType(InterfaceTypeBase value)

Set the property corresponding to InterfaceTypeEntry.getInterfaceType() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new InterfaceTypeEntry instance.

Returns:

A new InterfaceTypeEntry instance.