Class PacketTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.packet.type._case.PacketTypeBuilder
-
@Generated("mdsal-binding-generator") public class PacketTypeBuilder extends Object
Class that buildsPacketType
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:
PacketType createPacketType(int fooXyzzy, int barBaz) { return new PacketTypeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketType, 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:
PacketType
- 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 PacketTypeBuilder()
Construct an empty builder.PacketTypeBuilder(PacketType base)
Construct a builder initialized with state from specifiedPacketType
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketType>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PacketType
build()
A newPacketType
instance.org.opendaylight.yangtools.yang.common.Uint32
getPacketType()
Return current value associated with the property corresponding toPacketType.getPacketType()
.PacketTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketType>> augmentationType)
Remove an augmentation from this builder's product.PacketTypeBuilder
setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPacketType.getPacketType()
to the specified value.
-
-
-
Constructor Detail
-
PacketTypeBuilder
public PacketTypeBuilder()
Construct an empty builder.
-
PacketTypeBuilder
public PacketTypeBuilder(PacketType base)
Construct a builder initialized with state from specifiedPacketType
.- Parameters:
base
- PacketType from which the builder should be initialized
-
-
Method Detail
-
getPacketType
public org.opendaylight.yangtools.yang.common.Uint32 getPacketType()
Return current value associated with the property corresponding toPacketType.getPacketType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketType>> 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
-
setPacketType
public PacketTypeBuilder setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPacketType.getPacketType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PacketTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketType> 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 PacketTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketType>> 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 PacketType build()
A newPacketType
instance.- Returns:
- A new
PacketType
instance.
-
-