Class PortStatusMaskBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.async.config.service.rev170619.async.config.PortStatusMaskBuilder
-
@Generated("mdsal-binding-generator") public class PortStatusMaskBuilder extends Object
Class that buildsPortStatusMask
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:
PortStatusMask createPortStatusMask(int fooXyzzy, int barBaz) { return new PortStatusMaskBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortStatusMask, 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:
PortStatusMask
- 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 PortStatusMaskBuilder()
Construct an empty builder.PortStatusMaskBuilder(PortStatusMask base)
Construct a builder initialized with state from specifiedPortStatusMask
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PortStatusMaskBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMask> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMask>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PortStatusMask
build()
A newPortStatusMask
instance.PortStatusMask
getMasterMask()
Return current value associated with the property corresponding toPortStatusMask.getMasterMask()
.PortStatusMask
getSlaveMask()
Return current value associated with the property corresponding toPortStatusMask.getSlaveMask()
.PortStatusMaskBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMask>> augmentationType)
Remove an augmentation from this builder's product.PortStatusMaskBuilder
setMasterMask(PortStatusMask value)
Set the property corresponding toPortStatusMask.getMasterMask()
to the specified value.PortStatusMaskBuilder
setSlaveMask(PortStatusMask value)
Set the property corresponding toPortStatusMask.getSlaveMask()
to the specified value.
-
-
-
Constructor Detail
-
PortStatusMaskBuilder
public PortStatusMaskBuilder()
Construct an empty builder.
-
PortStatusMaskBuilder
public PortStatusMaskBuilder(PortStatusMask base)
Construct a builder initialized with state from specifiedPortStatusMask
.- Parameters:
base
- PortStatusMask from which the builder should be initialized
-
-
Method Detail
-
getMasterMask
public PortStatusMask getMasterMask()
Return current value associated with the property corresponding toPortStatusMask.getMasterMask()
.- Returns:
- current value
-
getSlaveMask
public PortStatusMask getSlaveMask()
Return current value associated with the property corresponding toPortStatusMask.getSlaveMask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMask>> 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
-
setMasterMask
public PortStatusMaskBuilder setMasterMask(PortStatusMask value)
Set the property corresponding toPortStatusMask.getMasterMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSlaveMask
public PortStatusMaskBuilder setSlaveMask(PortStatusMask value)
Set the property corresponding toPortStatusMask.getSlaveMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PortStatusMaskBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMask> 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 PortStatusMaskBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortStatusMask>> 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 PortStatusMask build()
A newPortStatusMask
instance.- Returns:
- A new
PortStatusMask
instance.
-
-