Class ExtensionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.extensions.rev160617.extensions.attributes.extensions.ExtensionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Extension>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Extension,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ExtensionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Extension>
Class that buildsExtensionBuilder
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:
ExtensionBuilder createTarget(int fooXyzzy, int barBaz) { return new ExtensionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExtensionBuilder, 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:
ExtensionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExtensionBuilder()
ExtensionBuilder(ExtensionAttributes arg)
ExtensionBuilder(Extension base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExtensionBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Extension>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Extension> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Extension>>
E$$augmentation(Class<E$$> augmentationType)
Extension
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getAlias()
String
getConfiguration()
String
getName()
ExtensionKey
key()
ExtensionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Extension>> augmentationType)
ExtensionBuilder
setAlias(String value)
ExtensionBuilder
setConfiguration(String value)
ExtensionBuilder
setName(String value)
ExtensionBuilder
withKey(ExtensionKey key)
-
-
-
Constructor Detail
-
ExtensionBuilder
public ExtensionBuilder()
-
ExtensionBuilder
public ExtensionBuilder(ExtensionAttributes arg)
-
ExtensionBuilder
public ExtensionBuilder(Extension 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.neutron.extensions.rev160617.ExtensionAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public ExtensionKey key()
-
getAlias
public String getAlias()
-
getConfiguration
public String getConfiguration()
-
getName
public String getName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Extension>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ExtensionBuilder withKey(ExtensionKey key)
-
setAlias
public ExtensionBuilder setAlias(String value)
-
setConfiguration
public ExtensionBuilder setConfiguration(String value)
-
setName
public ExtensionBuilder setName(String value)
-
addAugmentation
public ExtensionBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Extension>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Extension> augmentationValue)
-
removeAugmentation
public ExtensionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Extension>> augmentationType)
-
build
public Extension build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Extension>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Extension,IllegalArgumentException>
-
-