Class TrunksBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.TrunksBuilder
-
@Generated("mdsal-binding-generator") public class TrunksBuilder extends Object
Class that buildsTrunks
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:
Trunks createTrunks(int fooXyzzy, int barBaz) { return new TrunksBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Trunks, 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:
Trunks
- 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 TrunksBuilder()
Construct an empty builder.TrunksBuilder(Trunks base)
Construct a builder initialized with state from specifiedTrunks
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TrunksBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Trunks> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunks>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Trunks
build()
A newTrunks
instance.org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
getTrunk()
Return current value associated with the property corresponding toTrunks.getTrunk()
.TrunksBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunks>> augmentationType)
Remove an augmentation from this builder's product.TrunksBuilder
setTrunk(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
Set the property corresponding toTrunks.getTrunk()
to the specified value.
-
-
-
Method Detail
-
getTrunk
public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getTrunk()
Return current value associated with the property corresponding toTrunks.getTrunk()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunks>> 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
-
setTrunk
public TrunksBuilder setTrunk(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
Set the property corresponding toTrunks.getTrunk()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TrunksBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Trunks> 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 TrunksBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunks>> 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
-
-