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

Class ProtocolEntryBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryBuilder

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

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

   
     ProtocolEntry createProtocolEntry(int fooXyzzy, int barBaz) {
         return new ProtocolEntryBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

ProtocolEntry

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolEntryBuilder

public ProtocolEntryBuilder()

Construct an empty builder.

ProtocolEntryBuilder

public ProtocolEntryBuilder(ProtocolEntry base)

Construct a builder initialized with state from specified ProtocolEntry.

Parameters:

base - ProtocolEntry from which the builder should be initialized

Method Detail

key

public ProtocolEntryKey key()

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

Returns:

current value

getProtocol

public Class<? extends OvsdbBridgeProtocolBase> getProtocol()

Return current value associated with the property corresponding to ProtocolEntry.getProtocol().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolEntry>> 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 ProtocolEntryBuilder withKey(ProtocolEntryKey key)

setProtocol

public ProtocolEntryBuilder setProtocol(Class<? extends OvsdbBridgeProtocolBase> value)

Set the property corresponding to ProtocolEntry.getProtocol() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new ProtocolEntry instance.

Returns:

A new ProtocolEntry instance.