Class TableBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Table>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Table,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TableBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Table>
Class that buildsTableBuilder
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:
TableBuilder createTarget(int fooXyzzy, int barBaz) { return new TableBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TableBuilder, 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 oportunities, 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:
TableBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TableBuilder()
TableBuilder(Table base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TableBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Table> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Table>>
E$$augmentation(Class<E$$> augmentationType)
Table
build()
Map<FlowKey,Flow>
getFlow()
org.opendaylight.yangtools.yang.common.Uint8
getId()
Map<StaleFlowKey,StaleFlow>
getStaleFlow()
TableKey
key()
TableBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Table>> augmentationType)
Remove an augmentation from this builder's product.TableBuilder
setFlow(List<Flow> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFlow(Map)
instead.TableBuilder
setFlow(Map<FlowKey,Flow> values)
TableBuilder
setId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetId(Uint8)
instead.TableBuilder
setId(org.opendaylight.yangtools.yang.common.Uint8 value)
TableBuilder
setStaleFlow(List<StaleFlow> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStaleFlow(Map)
instead.TableBuilder
setStaleFlow(Map<StaleFlowKey,StaleFlow> values)
TableBuilder
withKey(TableKey key)
-
-
-
Constructor Detail
-
TableBuilder
public TableBuilder()
-
TableBuilder
public TableBuilder(Table base)
-
-
Method Detail
-
key
public TableKey key()
-
getId
public org.opendaylight.yangtools.yang.common.Uint8 getId()
-
getStaleFlow
public Map<StaleFlowKey,StaleFlow> getStaleFlow()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Table>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public TableBuilder withKey(TableKey key)
-
setFlow
public TableBuilder setFlow(Map<FlowKey,Flow> values)
-
setFlow
@Deprecated(forRemoval=true) public TableBuilder setFlow(List<Flow> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFlow(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setId
public TableBuilder setId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setId
@Deprecated(forRemoval=true) public TableBuilder setId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetId(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setStaleFlow
public TableBuilder setStaleFlow(Map<StaleFlowKey,StaleFlow> values)
-
setStaleFlow
@Deprecated(forRemoval=true) public TableBuilder setStaleFlow(List<StaleFlow> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStaleFlow(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public TableBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Table> 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 TableBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Table>> 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 Table build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Table>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Table,IllegalArgumentException>
-
-