Class AclBindingsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.AclBindingsBuilder
Class that builds
AclBindings
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:
AclBindings createAclBindings(int fooXyzzy, int barBaz) {
return new AclBindingsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of AclBindings, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedAclBindings
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<AclBindings> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AclBindings>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull AclBindings
build()
A newAclBindings
instance.org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
Return current value associated with the property corresponding toAclBindings.getAclBindingVlanId()
.Return current value associated with the property corresponding toAclBindings.getAclRef()
.key()
Return current value associated with the property corresponding toAclBindings.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AclBindings>> augmentationType) Remove an augmentation from this builder's product.setAclBindingVlanId
(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value) Set the property corresponding toAclBindings.getAclBindingVlanId()
to the specified value.setAclRef
(HwvtepAclRef value) Set the property corresponding toAclBindings.getAclRef()
to the specified value.withKey
(AclBindingsKey key) Set the key value corresponding toAclBindings.key()
to the specified value.
-
Constructor Details
-
AclBindingsBuilder
public AclBindingsBuilder()Construct an empty builder. -
AclBindingsBuilder
Construct a builder initialized with state from specifiedAclBindings
.- Parameters:
base
- AclBindings from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toAclBindings.key()
.- Returns:
- current value
-
getAclBindingVlanId
public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getAclBindingVlanId()Return current value associated with the property corresponding toAclBindings.getAclBindingVlanId()
.- Returns:
- current value
-
getAclRef
Return current value associated with the property corresponding toAclBindings.getAclRef()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AclBindings>> 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
Set the key value corresponding toAclBindings.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setAclBindingVlanId
public AclBindingsBuilder setAclBindingVlanId(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value) Set the property corresponding toAclBindings.getAclBindingVlanId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAclRef
Set the property corresponding toAclBindings.getAclRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AclBindingsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AclBindings> 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 AclBindingsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AclBindings>> 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
A newAclBindings
instance.- Returns:
- A new
AclBindings
instance.
-