Class TcpFlagsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.flowspec.flowspec.type.tcp.flags._case.TcpFlagsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TcpFlags>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TcpFlags,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TcpFlagsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TcpFlags>
Class that buildsTcpFlagsBuilder
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:
TcpFlagsBuilder createTarget(int fooXyzzy, int barBaz) { return new TcpFlagsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TcpFlagsBuilder, 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:
TcpFlagsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TcpFlagsBuilder()
TcpFlagsBuilder(BitmaskTwoByteValue arg)
TcpFlagsBuilder(TcpFlags base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TcpFlagsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlags> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlags>>
E$$augmentation(Class<E$$> augmentationType)
TcpFlags
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BitmaskOperand
getOp()
org.opendaylight.yangtools.yang.common.Uint16
getValue()
TcpFlagsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlags>> augmentationType)
Remove an augmentation from this builder's product.TcpFlagsBuilder
setOp(BitmaskOperand value)
TcpFlagsBuilder
setValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint16)
instead.TcpFlagsBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
TcpFlagsBuilder
public TcpFlagsBuilder()
-
TcpFlagsBuilder
public TcpFlagsBuilder(BitmaskTwoByteValue arg)
-
TcpFlagsBuilder
public TcpFlagsBuilder(TcpFlags 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.BitmaskTwoByteValue
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getOp
public BitmaskOperand getOp()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlags>> E$$ augmentation(Class<E$$> augmentationType)
-
setOp
public TcpFlagsBuilder setOp(BitmaskOperand value)
-
setValue
public TcpFlagsBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setValue
@Deprecated(forRemoval=true) public TcpFlagsBuilder setValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public TcpFlagsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlags> 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 TcpFlagsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpFlags>> 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 TcpFlags build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TcpFlags>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TcpFlags,IllegalArgumentException>
-
-