Class ArpOpBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.arp.op._case.ArpOpBuilder
Class that builds
ArpOp
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:
ArpOp createArpOp(int fooXyzzy, int barBaz) {
return new ArpOpBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ArpOp, 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.ArpOpBuilder
(ArpOp base) Construct a builder initialized with state from specifiedArpOp
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ArpOp
build()
A newArpOp
instance.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toArpOp.getOpCode()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>> augmentationType) Remove an augmentation from this builder's product.setOpCode
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toArpOp.getOpCode()
to the specified value.
-
Constructor Details
-
ArpOpBuilder
public ArpOpBuilder()Construct an empty builder. -
ArpOpBuilder
Construct a builder initialized with state from specifiedArpOp
.- Parameters:
base
- ArpOp from which the builder should be initialized
-
-
Method Details
-
getOpCode
public org.opendaylight.yangtools.yang.common.Uint16 getOpCode()Return current value associated with the property corresponding toArpOp.getOpCode()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>> 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
-
setOpCode
Set the property corresponding toArpOp.getOpCode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ArpOpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp> 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 ArpOpBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>> 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 newArpOp
instance.- Returns:
- A new
ArpOp
instance.
-