Class SourcePortCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.flowspec.flowspec.type.SourcePortCaseBuilder
-
@Generated("mdsal-binding-generator") public class SourcePortCaseBuilder extends Object
Class that buildsSourcePortCase
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:
SourcePortCase createSourcePortCase(int fooXyzzy, int barBaz) { return new SourcePortCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SourcePortCase, 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:
SourcePortCase
- 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 SourcePortCaseBuilder()
Construct an empty builder.SourcePortCaseBuilder(SourcePortCase base)
Construct a builder initialized with state from specifiedSourcePortCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SourcePortCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourcePortCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourcePortCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SourcePortCase
build()
A newSourcePortCase
instance.List<SourcePorts>
getSourcePorts()
Return current value associated with the property corresponding toSourcePortCase.getSourcePorts()
.SourcePortCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourcePortCase>> augmentationType)
Remove an augmentation from this builder's product.SourcePortCaseBuilder
setSourcePorts(List<SourcePorts> values)
Set the property corresponding toSourcePortCase.getSourcePorts()
to the specified value.
-
-
-
Constructor Detail
-
SourcePortCaseBuilder
public SourcePortCaseBuilder()
Construct an empty builder.
-
SourcePortCaseBuilder
public SourcePortCaseBuilder(SourcePortCase base)
Construct a builder initialized with state from specifiedSourcePortCase
.- Parameters:
base
- SourcePortCase from which the builder should be initialized
-
-
Method Detail
-
getSourcePorts
public List<SourcePorts> getSourcePorts()
Return current value associated with the property corresponding toSourcePortCase.getSourcePorts()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourcePortCase>> 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
-
setSourcePorts
public SourcePortCaseBuilder setSourcePorts(List<SourcePorts> values)
Set the property corresponding toSourcePortCase.getSourcePorts()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SourcePortCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourcePortCase> 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 SourcePortCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourcePortCase>> 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 SourcePortCase build()
A newSourcePortCase
instance.- Returns:
- A new
SourcePortCase
instance.
-
-