Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols

Class ProtocolBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.ProtocolBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Protocol>, org.opendaylight.yangtools.concepts.CheckedBuilder<Protocol,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class ProtocolBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Protocol>

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

   
     ProtocolBuilder createTarget(int fooXyzzy, int barBaz) {
         return new ProtocolBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

ProtocolBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
ProtocolBuilder()
ProtocolBuilder(Protocol base)

Method Summary

Modifier and Type	Method	Description
ProtocolBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Protocol>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Protocol> augmentationValue)	Deprecated, for removal: This API element is subject to removal in a future version. Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
ProtocolBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Protocol> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Protocol>> E$$	augmentation(Class<E$$> augmentationType)
Protocol	build()
Aggregate	getAggregate()
Config	getConfig()
Class<? extends InstallProtocolType>	getIdentifier()
String	getName()
State	getState()
Static	getStatic()
ProtocolKey	key()
ProtocolBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Protocol>> augmentationType)	Remove an augmentation from this builder's product.
ProtocolBuilder	setAggregate(Aggregate value)
ProtocolBuilder	setConfig(Config value)
ProtocolBuilder	setIdentifier(Class<? extends InstallProtocolType> value)
ProtocolBuilder	setName(String value)
ProtocolBuilder	setState(State value)
ProtocolBuilder	setStatic(Static value)
ProtocolBuilder	withKey(ProtocolKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolBuilder

public ProtocolBuilder()

ProtocolBuilder

public ProtocolBuilder(Protocol base)

Method Detail

key

public ProtocolKey key()

getAggregate

public Aggregate getAggregate()

getConfig

public Config getConfig()

getIdentifier

public Class<? extends InstallProtocolType> getIdentifier()

getName

public String getName()

getState

public State getState()

getStatic

public Static getStatic()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Protocol>> E$$ augmentation(Class<E$$> augmentationType)

withKey

public ProtocolBuilder withKey(ProtocolKey key)

setAggregate

public ProtocolBuilder setAggregate(Aggregate value)

setConfig

public ProtocolBuilder setConfig(Config value)

setIdentifier

public ProtocolBuilder setIdentifier(Class<? extends InstallProtocolType> value)

setName

public ProtocolBuilder setName(String value)

setState

public ProtocolBuilder setState(State value)

setStatic

public ProtocolBuilder setStatic(Static value)

addAugmentation

public ProtocolBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Protocol> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

addAugmentation

@Deprecated(forRemoval=true)
public ProtocolBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Protocol>> augmentationType,
                                       org.opendaylight.yangtools.yang.binding.Augmentation<Protocol> augmentationValue)

Deprecated, for removal: This API element is subject to removal in a future version.

Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.

Add or remove an augmentation to this builder's product.

Parameters:

augmentationType - augmentation type to be added or removed

augmentationValue - augmentation value, null if the augmentation type should be removed

Returns:

this builder

removeAugmentation

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

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<Protocol>

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Protocol,IllegalArgumentException>