Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.local.routing.rev151009.local._static.top
Class StaticRoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.local.routing.rev151009.local._static.top.StaticRoutesBuilder
-
@Generated("mdsal-binding-generator") public class StaticRoutesBuilder extends Object
Class that buildsStaticRoutes
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:
StaticRoutes createStaticRoutes(int fooXyzzy, int barBaz) { return new StaticRoutesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StaticRoutes, 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:
StaticRoutes
- 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 StaticRoutesBuilder()
Construct an empty builder.StaticRoutesBuilder(StaticRoutes base)
Construct a builder initialized with state from specifiedStaticRoutes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StaticRoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StaticRoutes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StaticRoutes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull StaticRoutes
build()
A newStaticRoutes
instance.Map<StaticKey,Static>
getStatic()
Return current value associated with the property corresponding toStaticRoutes.getStatic()
.StaticRoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StaticRoutes>> augmentationType)
Remove an augmentation from this builder's product.StaticRoutesBuilder
setStatic(Map<StaticKey,Static> values)
Set the property corresponding toStaticRoutes.getStatic()
to the specified value.
-
-
-
Constructor Detail
-
StaticRoutesBuilder
public StaticRoutesBuilder()
Construct an empty builder.
-
StaticRoutesBuilder
public StaticRoutesBuilder(StaticRoutes base)
Construct a builder initialized with state from specifiedStaticRoutes
.- Parameters:
base
- StaticRoutes from which the builder should be initialized
-
-
Method Detail
-
getStatic
public Map<StaticKey,Static> getStatic()
Return current value associated with the property corresponding toStaticRoutes.getStatic()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StaticRoutes>> 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
-
setStatic
public StaticRoutesBuilder setStatic(Map<StaticKey,Static> values)
Set the property corresponding toStaticRoutes.getStatic()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public StaticRoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StaticRoutes> 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 StaticRoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StaticRoutes>> 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 @NonNull StaticRoutes build()
A newStaticRoutes
instance.- Returns:
- A new
StaticRoutes
instance.
-
-