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