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