Class Level1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.isis.topology.rev131021.isis.node.attributes.isis.node.attributes.router.type.Level1Builder
-
@Generated("mdsal-binding-generator") public class Level1Builder extends Object
Class that buildsLevel1
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:
Level1 createLevel1(int fooXyzzy, int barBaz) { return new Level1Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Level1, 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:
Level1
- 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 Level1Builder()
Construct an empty builder.Level1Builder(Level1 base)
Construct a builder initialized with state from specifiedLevel1
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Level1Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Level1> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Level1>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Level1
build()
A newLevel1
instance.org.opendaylight.yangtools.yang.common.Empty
getLevel1()
Return current value associated with the property corresponding toLevel1.getLevel1()
.Level1Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Level1>> augmentationType)
Remove an augmentation from this builder's product.Level1Builder
setLevel1(org.opendaylight.yangtools.yang.common.Empty value)
Set the property corresponding toLevel1.getLevel1()
to the specified value.
-
-
-
Method Detail
-
getLevel1
public org.opendaylight.yangtools.yang.common.Empty getLevel1()
Return current value associated with the property corresponding toLevel1.getLevel1()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Level1>> 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
-
setLevel1
public Level1Builder setLevel1(org.opendaylight.yangtools.yang.common.Empty value)
Set the property corresponding toLevel1.getLevel1()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Level1Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Level1> 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 Level1Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Level1>> 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
-
-