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
-
@Generated("mdsal-binding-generator") public class PacketInMaskBuilder extends Object
Class that buildsPacketInMask
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:
PacketInMask createPacketInMask(int fooXyzzy, int barBaz) { return new PacketInMaskBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketInMask, 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:
PacketInMask
- 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 PacketInMaskBuilder()
Construct an empty builder.PacketInMaskBuilder(PacketInMask base)
Construct a builder initialized with state from specifiedPacketInMask
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketInMaskBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PacketInMask
build()
A newPacketInMask
instance.Set<PacketInReason>
getMask()
Return current value associated with the property corresponding toPacketInMask.getMask()
.PacketInMaskBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> augmentationType)
Remove an augmentation from this builder's product.PacketInMaskBuilder
setMask(Set<PacketInReason> values)
Set the property corresponding toPacketInMask.getMask()
to the specified value.
-
-
-
Constructor Detail
-
PacketInMaskBuilder
public PacketInMaskBuilder()
Construct an empty builder.
-
PacketInMaskBuilder
public PacketInMaskBuilder(PacketInMask base)
Construct a builder initialized with state from specifiedPacketInMask
.- Parameters:
base
- PacketInMask from which the builder should be initialized
-
-
Method Detail
-
getMask
public Set<PacketInReason> getMask()
Return current value associated with the property corresponding toPacketInMask.getMask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> 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
-
setMask
public PacketInMaskBuilder setMask(Set<PacketInReason> values)
Set the property corresponding toPacketInMask.getMask()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public PacketInMaskBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask> 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 PacketInMaskBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketInMask>> 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 PacketInMask build()
A newPacketInMask
instance.- Returns:
- A new
PacketInMask
instance.
-
-