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

Class OptionsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder

All Implemented Interfaces:

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

public class OptionsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Options>

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

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

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

OptionsBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
OptionsBuilder()
OptionsBuilder(Options base)

Method Summary

Modifier and Type	Method	Description
OptionsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Options> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> E$$	augmentation(Class<E$$> augmentationType)
Options	build()
String	getOption()
String	getValue()
OptionsKey	key()
OptionsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType)
OptionsBuilder	setOption(String value)
OptionsBuilder	setValue(String value)
OptionsBuilder	withKey(OptionsKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsBuilder

public OptionsBuilder()

OptionsBuilder

public OptionsBuilder(Options base)

Method Detail

key

public OptionsKey key()

getOption

public String getOption()

getValue

public String getValue()

augmentation

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

withKey

public OptionsBuilder withKey(OptionsKey key)

setOption

public OptionsBuilder setOption(String value)

setValue

public OptionsBuilder setValue(String value)

addAugmentation

public OptionsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType,
                                      org.opendaylight.yangtools.yang.binding.Augmentation<Options> augmentationValue)

removeAugmentation

public OptionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType)

build

public Options build()

Specified by:

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

Specified by:

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