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