Class StaticBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.local.routing.rev151009.local._static.top._static.routes.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>
@Generated("mdsal-binding-generator") 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(Static base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StaticBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Static> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>>
E$$augmentation(Class<E$$> augmentationType)
Static
build()
Config
getConfig()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
State
getState()
StaticKey
key()
StaticBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> augmentationType)
Remove an augmentation from this builder's product.StaticBuilder
setConfig(Config value)
StaticBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
StaticBuilder
setState(State value)
StaticBuilder
withKey(StaticKey key)
-
-
-
Constructor Detail
-
StaticBuilder
public StaticBuilder()
-
StaticBuilder
public StaticBuilder(Static base)
-
-
Method Detail
-
key
public StaticKey key()
-
getConfig
public Config getConfig()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public StaticBuilder withKey(StaticKey key)
-
setConfig
public StaticBuilder setConfig(Config value)
-
setPrefix
public StaticBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setState
public StaticBuilder setState(State value)
-
addAugmentation
public StaticBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Static> 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 StaticBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> 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 Static build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Static>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Static,IllegalArgumentException>
-
-