Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.async.body.grouping
Class PacketInMaskBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.async.body.grouping.PacketInMaskBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PacketInMask>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PacketInMask,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PacketInMaskBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketInMask>
Class that buildsPacketInMaskBuilder
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:
PacketInMaskBuilder createTarget(int fooXyzzy, int barBaz) { return new PacketInMaskBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketInMaskBuilder, 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:
PacketInMaskBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketInMaskBuilder()
PacketInMaskBuilder(PacketInMask base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketInMaskBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>>
E$$augmentation(Class<E$$> augmentationType)
PacketInMask
build()
List<PacketInReason>
getMask()
PacketInMaskBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> augmentationType)
PacketInMaskBuilder
setMask(List<PacketInReason> values)
-
-
-
Constructor Detail
-
PacketInMaskBuilder
public PacketInMaskBuilder()
-
PacketInMaskBuilder
public PacketInMaskBuilder(PacketInMask base)
-
-
Method Detail
-
getMask
public List<PacketInReason> getMask()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> E$$ augmentation(Class<E$$> augmentationType)
-
setMask
public PacketInMaskBuilder setMask(List<PacketInReason> values)
-
addAugmentation
public PacketInMaskBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask> augmentationValue)
-
removeAugmentation
public PacketInMaskBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> augmentationType)
-
build
public PacketInMask build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketInMask>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketInMask,IllegalArgumentException>
-
-