Class StaticBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.protocol.StaticBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Static>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Static,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class StaticBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Static>
Class that buildsStaticBuilder
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:
StaticBuilder createTarget(int fooXyzzy, int barBaz) { return new StaticBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StaticBuilder, 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:
StaticBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description StaticBuilder()
StaticBuilder(LocalStaticTop arg)
StaticBuilder(Static base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StaticBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Static> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>>
E$$augmentation(Class<E$$> augmentationType)
Static
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.StaticRoutes
getStaticRoutes()
StaticBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> augmentationType)
StaticBuilder
setStaticRoutes(StaticRoutes value)
-
-
-
Constructor Detail
-
StaticBuilder
public StaticBuilder()
-
StaticBuilder
public StaticBuilder(LocalStaticTop arg)
-
StaticBuilder
public StaticBuilder(Static 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.http.openconfig.net.yang.local.routing.rev151009.LocalStaticTop
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getStaticRoutes
public StaticRoutes getStaticRoutes()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> E$$ augmentation(Class<E$$> augmentationType)
-
setStaticRoutes
public StaticBuilder setStaticRoutes(StaticRoutes value)
-
addAugmentation
public StaticBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Static> augmentationValue)
-
removeAugmentation
public StaticBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> augmentationType)
-
build
public Static build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Static>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Static,IllegalArgumentException>
-
-