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