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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ArpOp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ArpOp,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ArpOpBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ArpOp>
Class that buildsArpOpBuilder
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:
ArpOpBuilder createTarget(int fooXyzzy, int barBaz) { return new ArpOpBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ArpOpBuilder, 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 oportunities, 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:
ArpOpBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ArpOpBuilder()
ArpOpBuilder(ArpOp base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ArpOpBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.ArpOpBuilder
addAugmentation(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)
ArpOp
build()
org.opendaylight.yangtools.yang.common.Uint16
getOpCode()
ArpOpBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>> augmentationType)
Remove an augmentation from this builder's product.ArpOpBuilder
setOpCode(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOpCode(Uint16)
instead.ArpOpBuilder
setOpCode(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
ArpOpBuilder
public ArpOpBuilder()
-
ArpOpBuilder
public ArpOpBuilder(ArpOp base)
-
-
Method Detail
-
getOpCode
public org.opendaylight.yangtools.yang.common.Uint16 getOpCode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>> E$$ augmentation(Class<E$$> augmentationType)
-
setOpCode
public ArpOpBuilder setOpCode(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setOpCode
@Deprecated(forRemoval=true) public ArpOpBuilder setOpCode(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOpCode(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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
-
addAugmentation
@Deprecated(forRemoval=true) public ArpOpBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ArpOp> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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
public ArpOp build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ArpOp>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ArpOp,IllegalArgumentException>
-
-