Class ElementsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.hello.ElementsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Elements>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Elements,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ElementsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Elements>
Class that buildsElementsBuilder
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:
ElementsBuilder createTarget(int fooXyzzy, int barBaz) { return new ElementsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ElementsBuilder, 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:
ElementsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ElementsBuilder()
ElementsBuilder(Elements base)
ElementsBuilder(OfHelloElementHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ElementsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Elements> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>>
E$$augmentation(Class<E$$> augmentationType)
Elements
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.HelloElementType
getType()
List<Boolean>
getVersionBitmap()
ElementsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>> augmentationType)
ElementsBuilder
setType(HelloElementType value)
ElementsBuilder
setVersionBitmap(List<Boolean> values)
-
-
-
Constructor Detail
-
ElementsBuilder
public ElementsBuilder()
-
ElementsBuilder
public ElementsBuilder(OfHelloElementHeader arg)
-
ElementsBuilder
public ElementsBuilder(Elements base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHelloElementHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getType
public HelloElementType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>> E$$ augmentation(Class<E$$> augmentationType)
-
setType
public ElementsBuilder setType(HelloElementType value)
-
setVersionBitmap
public ElementsBuilder setVersionBitmap(List<Boolean> values)
-
addAugmentation
public ElementsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Elements> augmentationValue)
-
removeAugmentation
public ElementsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Elements>> augmentationType)
-
build
public Elements build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Elements>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Elements,IllegalArgumentException>
-
-