Class TableModInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.TableModInputBuilder
-
@Generated("mdsal-binding-generator") public class TableModInputBuilder extends Object
Class that buildsTableModInput
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:
TableModInput createTableModInput(int fooXyzzy, int barBaz) { return new TableModInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TableModInput, 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:
TableModInput
- 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 TableModInputBuilder()
Construct an empty builder.TableModInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.TableModInputBuilder(TableMod$G arg)
Construct a new builder initialized from specifiedTableMod$G
.TableModInputBuilder(TableModInput base)
Construct a builder initialized with state from specifiedTableModInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TableModInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableModInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableModInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TableModInput
build()
A newTableModInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.TableConfig
getConfig()
Return current value associated with the property corresponding toTableMod$G.getConfig()
.TableId
getTableId()
Return current value associated with the property corresponding toTableMod$G.getTableId()
.org.opendaylight.yangtools.yang.common.Uint8
getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.org.opendaylight.yangtools.yang.common.Uint32
getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.TableModInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableModInput>> augmentationType)
Remove an augmentation from this builder's product.TableModInputBuilder
setConfig(TableConfig value)
Set the property corresponding toTableMod$G.getConfig()
to the specified value.TableModInputBuilder
setTableId(TableId value)
Set the property corresponding toTableMod$G.getTableId()
to the specified value.TableModInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.TableModInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
TableModInputBuilder
public TableModInputBuilder()
Construct an empty builder.
-
TableModInputBuilder
public TableModInputBuilder(TableMod$G arg)
Construct a new builder initialized from specifiedTableMod$G
.- Parameters:
arg
- TableMod$G from which the builder should be initialized
-
TableModInputBuilder
public TableModInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
TableModInputBuilder
public TableModInputBuilder(TableModInput base)
Construct a builder initialized with state from specifiedTableModInput
.- Parameters:
base
- TableModInput 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
-
getConfig
public TableConfig getConfig()
Return current value associated with the property corresponding toTableMod$G.getConfig()
.- Returns:
- current value
-
getTableId
public TableId getTableId()
Return current value associated with the property corresponding toTableMod$G.getTableId()
.- Returns:
- current value
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.- Returns:
- current value
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableModInput>> 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
-
setConfig
public TableModInputBuilder setConfig(TableConfig value)
Set the property corresponding toTableMod$G.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public TableModInputBuilder setTableId(TableId value)
Set the property corresponding toTableMod$G.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public TableModInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
public TableModInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TableModInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableModInput> 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 TableModInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableModInput>> 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 TableModInput build()
A newTableModInput
instance.- Returns:
- A new
TableModInput
instance.
-
-