Class OriginalTableBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.table.update.OriginalTableBuilder
-
@Generated("mdsal-binding-generator") public class OriginalTableBuilder extends Object
Class that buildsOriginalTable
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:
OriginalTable createOriginalTable(int fooXyzzy, int barBaz) { return new OriginalTableBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OriginalTable, 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:
OriginalTable
- 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 OriginalTableBuilder()
Construct an empty builder.OriginalTableBuilder(OriginalTable base)
Construct a builder initialized with state from specifiedOriginalTable
.OriginalTableBuilder(TableFeatures arg)
Construct a new builder initialized from specifiedTableFeatures
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OriginalTableBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OriginalTable> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalTable>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull OriginalTable
build()
A newOriginalTable
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<TableFeaturesKey,TableFeatures>
getTableFeatures()
Return current value associated with the property corresponding toTableFeatures.getTableFeatures()
.OriginalTableBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalTable>> augmentationType)
Remove an augmentation from this builder's product.OriginalTableBuilder
setTableFeatures(Map<TableFeaturesKey,TableFeatures> values)
Set the property corresponding toTableFeatures.getTableFeatures()
to the specified value.
-
-
-
Constructor Detail
-
OriginalTableBuilder
public OriginalTableBuilder()
Construct an empty builder.
-
OriginalTableBuilder
public OriginalTableBuilder(TableFeatures arg)
Construct a new builder initialized from specifiedTableFeatures
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures from which the builder should be initialized
-
OriginalTableBuilder
public OriginalTableBuilder(OriginalTable base)
Construct a builder initialized with state from specifiedOriginalTable
.- Parameters:
base
- OriginalTable from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getTableFeatures
public Map<TableFeaturesKey,TableFeatures> getTableFeatures()
Return current value associated with the property corresponding toTableFeatures.getTableFeatures()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalTable>> 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
-
setTableFeatures
public OriginalTableBuilder setTableFeatures(Map<TableFeaturesKey,TableFeatures> values)
Set the property corresponding toTableFeatures.getTableFeatures()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public OriginalTableBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OriginalTable> 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 OriginalTableBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalTable>> 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 OriginalTable build()
A newOriginalTable
instance.- Returns:
- A new
OriginalTable
instance.
-
-