Class PacketLengthsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.flowspec.flowspec.type.packet.length._case.PacketLengthsBuilder
-
@Generated("mdsal-binding-generator") public class PacketLengthsBuilder extends Object
Class that buildsPacketLengths
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:
PacketLengths createPacketLengths(int fooXyzzy, int barBaz) { return new PacketLengthsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketLengths, 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:
PacketLengths
- 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 PacketLengthsBuilder()
Construct an empty builder.PacketLengthsBuilder(PacketLengths base)
Construct a builder initialized with state from specifiedPacketLengths
.PacketLengthsBuilder(NumericTwoByteValue arg)
Construct a new builder initialized from specifiedNumericTwoByteValue
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketLengthsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PacketLengths
build()
A newPacketLengths
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NumericOperand
getOp()
Return current value associated with the property corresponding toNumericTwoByteValue.getOp()
.org.opendaylight.yangtools.yang.common.Uint16
getValue()
Return current value associated with the property corresponding toNumericTwoByteValue.getValue()
.PacketLengthsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> augmentationType)
Remove an augmentation from this builder's product.PacketLengthsBuilder
setOp(NumericOperand value)
Set the property corresponding toNumericTwoByteValue.getOp()
to the specified value.PacketLengthsBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNumericTwoByteValue.getValue()
to the specified value.
-
-
-
Constructor Detail
-
PacketLengthsBuilder
public PacketLengthsBuilder()
Construct an empty builder.
-
PacketLengthsBuilder
public PacketLengthsBuilder(NumericTwoByteValue arg)
Construct a new builder initialized from specifiedNumericTwoByteValue
.- Parameters:
arg
- NumericTwoByteValue from which the builder should be initialized
-
PacketLengthsBuilder
public PacketLengthsBuilder(PacketLengths base)
Construct a builder initialized with state from specifiedPacketLengths
.- Parameters:
base
- PacketLengths from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getOp
public NumericOperand getOp()
Return current value associated with the property corresponding toNumericTwoByteValue.getOp()
.- Returns:
- current value
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
Return current value associated with the property corresponding toNumericTwoByteValue.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> 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
-
setOp
public PacketLengthsBuilder setOp(NumericOperand value)
Set the property corresponding toNumericTwoByteValue.getOp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public PacketLengthsBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNumericTwoByteValue.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PacketLengthsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths> 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 PacketLengthsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> 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 PacketLengths build()
A newPacketLengths
instance.- Returns:
- A new
PacketLengths
instance.
-
-