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>
@Generated("mdsal-binding-generator") public class OptionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Options>
Class that buildsOptionsBuilder
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OptionsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Options> augmentation)
Add an augmentation to this builder's product.<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)
Remove an augmentation from this builder's product.OptionsBuilder
setOption(String value)
OptionsBuilder
setValue(String value)
OptionsBuilder
withKey(OptionsKey key)
-
-
-
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(org.opendaylight.yangtools.yang.binding.Augmentation<Options> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public OptionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> 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 Options build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Options>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Options,IllegalArgumentException>
-
-