Class TableModInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.TableModInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TableModInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TableModInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TableModInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TableModInput>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description TableModInputBuilder()
TableModInputBuilder(OfHeader arg)
TableModInputBuilder(TableMod$G arg)
TableModInputBuilder(TableModInput base)
-
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)
TableModInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.TableConfig
getConfig()
TableId
getTableId()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
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)
TableModInputBuilder
setTableId(TableId value)
TableModInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
TableModInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
TableModInputBuilder
public TableModInputBuilder()
-
TableModInputBuilder
public TableModInputBuilder(TableMod$G arg)
-
TableModInputBuilder
public TableModInputBuilder(OfHeader arg)
-
TableModInputBuilder
public TableModInputBuilder(TableModInput base)
-
-
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:- OfHeader
- TableMod$G
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getConfig
public TableConfig getConfig()
-
getTableId
public TableId getTableId()
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableModInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfig
public TableModInputBuilder setConfig(TableConfig value)
-
setTableId
public TableModInputBuilder setTableId(TableId value)
-
setVersion
public TableModInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public TableModInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
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 TableModInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TableModInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TableModInput,IllegalArgumentException>
-
-