Class PortFaultStatusBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatusBuilder
-
@Generated("mdsal-binding-generator") public class PortFaultStatusBuilder extends Object
Class that buildsPortFaultStatus
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:
PortFaultStatus createPortFaultStatus(int fooXyzzy, int barBaz) { return new PortFaultStatusBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortFaultStatus, 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:
PortFaultStatus
- 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 PortFaultStatusBuilder()
Construct an empty builder.PortFaultStatusBuilder(PortFaultStatus base)
Construct a builder initialized with state from specifiedPortFaultStatus
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PortFaultStatusBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortFaultStatus> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortFaultStatus>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PortFaultStatus
build()
A newPortFaultStatus
instance.String
getPortFaultStatusKey()
Return current value associated with the property corresponding toPortFaultStatus.getPortFaultStatusKey()
.String
getPortFaultStatusValue()
Return current value associated with the property corresponding toPortFaultStatus.getPortFaultStatusValue()
.PortFaultStatusKey
key()
Return current value associated with the property corresponding toPortFaultStatus.key()
.PortFaultStatusBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortFaultStatus>> augmentationType)
Remove an augmentation from this builder's product.PortFaultStatusBuilder
setPortFaultStatusKey(String value)
Set the property corresponding toPortFaultStatus.getPortFaultStatusKey()
to the specified value.PortFaultStatusBuilder
setPortFaultStatusValue(String value)
Set the property corresponding toPortFaultStatus.getPortFaultStatusValue()
to the specified value.PortFaultStatusBuilder
withKey(PortFaultStatusKey key)
-
-
-
Constructor Detail
-
PortFaultStatusBuilder
public PortFaultStatusBuilder()
Construct an empty builder.
-
PortFaultStatusBuilder
public PortFaultStatusBuilder(PortFaultStatus base)
Construct a builder initialized with state from specifiedPortFaultStatus
.- Parameters:
base
- PortFaultStatus from which the builder should be initialized
-
-
Method Detail
-
key
public PortFaultStatusKey key()
Return current value associated with the property corresponding toPortFaultStatus.key()
.- Returns:
- current value
-
getPortFaultStatusKey
public String getPortFaultStatusKey()
Return current value associated with the property corresponding toPortFaultStatus.getPortFaultStatusKey()
.- Returns:
- current value
-
getPortFaultStatusValue
public String getPortFaultStatusValue()
Return current value associated with the property corresponding toPortFaultStatus.getPortFaultStatusValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortFaultStatus>> 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 PortFaultStatusBuilder withKey(PortFaultStatusKey key)
-
setPortFaultStatusKey
public PortFaultStatusBuilder setPortFaultStatusKey(String value)
Set the property corresponding toPortFaultStatus.getPortFaultStatusKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPortFaultStatusValue
public PortFaultStatusBuilder setPortFaultStatusValue(String value)
Set the property corresponding toPortFaultStatus.getPortFaultStatusValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PortFaultStatusBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortFaultStatus> 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 PortFaultStatusBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortFaultStatus>> 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 PortFaultStatus build()
A newPortFaultStatus
instance.- Returns:
- A new
PortFaultStatus
instance.
-
-