Class StaticBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.local.routing.rev151009.local._static.top._static.routes.StaticBuilder
-
@Generated("mdsal-binding-generator") public class StaticBuilder extends Object
Class that buildsStatic
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:
Static createStatic(int fooXyzzy, int barBaz) { return new StaticBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Static, 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 opportunities, 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:
Static
- 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
-
-
Constructor Summary
Constructors Constructor Description StaticBuilder()
Construct an empty builder.StaticBuilder(Static base)
Construct a builder initialized with state from specifiedStatic
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull Static
build()
A newStatic
instance.Config
getConfig()
Return current value associated with the property corresponding toStatic.getConfig()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
Return current value associated with the property corresponding toStatic.getPrefix()
.State
getState()
Return current value associated with the property corresponding toStatic.getState()
.StaticKey
key()
Return current value associated with the property corresponding toStatic.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)
Set the property corresponding toStatic.getConfig()
to the specified value.StaticBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
Set the property corresponding toStatic.getPrefix()
to the specified value.StaticBuilder
setState(State value)
Set the property corresponding toStatic.getState()
to the specified value.StaticBuilder
withKey(StaticKey key)
-
-
-
Method Detail
-
key
public StaticKey key()
Return current value associated with the property corresponding toStatic.key()
.- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toStatic.getConfig()
.- Returns:
- current value
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
Return current value associated with the property corresponding toStatic.getPrefix()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toStatic.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Static>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public StaticBuilder withKey(StaticKey key)
-
setConfig
public StaticBuilder setConfig(Config value)
Set the property corresponding toStatic.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefix
public StaticBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
Set the property corresponding toStatic.getPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public StaticBuilder setState(State value)
Set the property corresponding toStatic.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-