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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PacketLengths>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PacketLengths,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PacketLengthsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketLengths>
Class that buildsPacketLengthsBuilder
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:
PacketLengthsBuilder createTarget(int fooXyzzy, int barBaz) { return new PacketLengthsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketLengthsBuilder, 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:
PacketLengthsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketLengthsBuilder()
PacketLengthsBuilder(PacketLengths base)
PacketLengthsBuilder(NumericTwoByteValue arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PacketLengthsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>>
E$$augmentation(Class<E$$> augmentationType)
PacketLengths
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NumericOperand
getOp()
org.opendaylight.yangtools.yang.common.Uint16
getValue()
PacketLengthsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> augmentationType)
PacketLengthsBuilder
setOp(NumericOperand value)
PacketLengthsBuilder
setValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint16)} instead.PacketLengthsBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
PacketLengthsBuilder
public PacketLengthsBuilder()
-
PacketLengthsBuilder
public PacketLengthsBuilder(NumericTwoByteValue arg)
-
PacketLengthsBuilder
public PacketLengthsBuilder(PacketLengths base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.NumericTwoByteValue
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getOp
public NumericOperand getOp()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> E$$ augmentation(Class<E$$> augmentationType)
-
setOp
public PacketLengthsBuilder setOp(NumericOperand value)
-
setValue
public PacketLengthsBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setValue
@Deprecated(forRemoval=true) public PacketLengthsBuilder setValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public PacketLengthsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths> augmentationValue)
-
removeAugmentation
public PacketLengthsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketLengths>> augmentationType)
-
build
public PacketLengths build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketLengths>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketLengths,IllegalArgumentException>
-
-