Class LocatorSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.locator.set.attributes.LocatorSetBuilder
-
@Generated("mdsal-binding-generator") public class LocatorSetBuilder extends Object
Class that buildsLocatorSet
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:
LocatorSet createLocatorSet(int fooXyzzy, int barBaz) { return new LocatorSetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LocatorSet, 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:
LocatorSet
- 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 LocatorSetBuilder()
Construct an empty builder.LocatorSetBuilder(LocatorSet base)
Construct a builder initialized with state from specifiedLocatorSet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LocatorSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocatorSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorSet>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LocatorSet
build()
A newLocatorSet
instance.HwvtepPhysicalLocatorRef
getLocatorRef()
Return current value associated with the property corresponding toLocatorSet.getLocatorRef()
.LocatorSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorSet>> augmentationType)
Remove an augmentation from this builder's product.LocatorSetBuilder
setLocatorRef(HwvtepPhysicalLocatorRef value)
Set the property corresponding toLocatorSet.getLocatorRef()
to the specified value.
-
-
-
Constructor Detail
-
LocatorSetBuilder
public LocatorSetBuilder()
Construct an empty builder.
-
LocatorSetBuilder
public LocatorSetBuilder(LocatorSet base)
Construct a builder initialized with state from specifiedLocatorSet
.- Parameters:
base
- LocatorSet from which the builder should be initialized
-
-
Method Detail
-
getLocatorRef
public HwvtepPhysicalLocatorRef getLocatorRef()
Return current value associated with the property corresponding toLocatorSet.getLocatorRef()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorSet>> 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
-
setLocatorRef
public LocatorSetBuilder setLocatorRef(HwvtepPhysicalLocatorRef value)
Set the property corresponding toLocatorSet.getLocatorRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LocatorSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocatorSet> 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 LocatorSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocatorSet>> 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 LocatorSet build()
A newLocatorSet
instance.- Returns:
- A new
LocatorSet
instance.
-
-