Class AclEntriesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.acl.attributes.AclEntriesBuilder
-
@Generated("mdsal-binding-generator") public class AclEntriesBuilder extends Object
Class that buildsAclEntries
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:
AclEntries createAclEntries(int fooXyzzy, int barBaz) { return new AclEntriesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AclEntries, 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:
AclEntries
- 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 AclEntriesBuilder()
Construct an empty builder.AclEntriesBuilder(AclEntries base)
Construct a builder initialized with state from specifiedAclEntries
.AclEntriesBuilder(HwvtepAclEntryAttributes arg)
Construct a new builder initialized from specifiedHwvtepAclEntryAttributes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AclEntriesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AclEntries> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AclEntries>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull AclEntries
build()
A newAclEntries
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<AcleFaultStatusKey,AcleFaultStatus>
getAcleFaultStatus()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getAcleFaultStatus()
.IetfAclEntryRef
getAclEntryRef()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getAclEntryRef()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getAclEntryUuid()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getAclEntryUuid()
.org.opendaylight.yangtools.yang.common.Uint32
getSequence()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getSequence()
.AclEntriesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AclEntries>> augmentationType)
Remove an augmentation from this builder's product.AclEntriesBuilder
setAcleFaultStatus(Map<AcleFaultStatusKey,AcleFaultStatus> values)
Set the property corresponding toHwvtepAclEntryAttributes.getAcleFaultStatus()
to the specified value.AclEntriesBuilder
setAclEntryRef(IetfAclEntryRef value)
Set the property corresponding toHwvtepAclEntryAttributes.getAclEntryRef()
to the specified value.AclEntriesBuilder
setAclEntryUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepAclEntryAttributes.getAclEntryUuid()
to the specified value.AclEntriesBuilder
setSequence(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toHwvtepAclEntryAttributes.getSequence()
to the specified value.
-
-
-
Constructor Detail
-
AclEntriesBuilder
public AclEntriesBuilder()
Construct an empty builder.
-
AclEntriesBuilder
public AclEntriesBuilder(HwvtepAclEntryAttributes arg)
Construct a new builder initialized from specifiedHwvtepAclEntryAttributes
.- Parameters:
arg
- HwvtepAclEntryAttributes from which the builder should be initialized
-
AclEntriesBuilder
public AclEntriesBuilder(AclEntries base)
Construct a builder initialized with state from specifiedAclEntries
.- Parameters:
base
- AclEntries from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAclEntryRef
public IetfAclEntryRef getAclEntryRef()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getAclEntryRef()
.- Returns:
- current value
-
getAclEntryUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getAclEntryUuid()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getAclEntryUuid()
.- Returns:
- current value
-
getAcleFaultStatus
public Map<AcleFaultStatusKey,AcleFaultStatus> getAcleFaultStatus()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getAcleFaultStatus()
.- Returns:
- current value
-
getSequence
public org.opendaylight.yangtools.yang.common.Uint32 getSequence()
Return current value associated with the property corresponding toHwvtepAclEntryAttributes.getSequence()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AclEntries>> 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
-
setAclEntryRef
public AclEntriesBuilder setAclEntryRef(IetfAclEntryRef value)
Set the property corresponding toHwvtepAclEntryAttributes.getAclEntryRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAclEntryUuid
public AclEntriesBuilder setAclEntryUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepAclEntryAttributes.getAclEntryUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAcleFaultStatus
public AclEntriesBuilder setAcleFaultStatus(Map<AcleFaultStatusKey,AcleFaultStatus> values)
Set the property corresponding toHwvtepAclEntryAttributes.getAcleFaultStatus()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSequence
public AclEntriesBuilder setSequence(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toHwvtepAclEntryAttributes.getSequence()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AclEntriesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AclEntries> 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 AclEntriesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AclEntries>> 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 AclEntries build()
A newAclEntries
instance.- Returns:
- A new
AclEntries
instance.
-
-