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