Class TableFeaturePropertiesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.table.features.table.properties.TableFeaturePropertiesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TableFeatureProperties>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TableFeatureProperties,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TableFeaturePropertiesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TableFeatureProperties>
Class that buildsTableFeaturePropertiesBuilder
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:
TableFeaturePropertiesBuilder createTarget(int fooXyzzy, int barBaz) { return new TableFeaturePropertiesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TableFeaturePropertiesBuilder, 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:
TableFeaturePropertiesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TableFeaturePropertiesBuilder()
TableFeaturePropertiesBuilder(Ordered arg)
TableFeaturePropertiesBuilder(TableFeatureProperties base)
TableFeaturePropertiesBuilder(TableFeaturePropType arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TableFeaturePropertiesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>>
E$$augmentation(Class<E$$> augmentationType)
TableFeatureProperties
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Integer
getOrder()
TableFeaturePropType
getTableFeaturePropType()
TableFeaturePropertiesKey
key()
TableFeaturePropertiesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> augmentationType)
TableFeaturePropertiesBuilder
setOrder(Integer value)
TableFeaturePropertiesBuilder
setTableFeaturePropType(TableFeaturePropType value)
TableFeaturePropertiesBuilder
withKey(TableFeaturePropertiesKey key)
-
-
-
Constructor Detail
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder()
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder(Ordered arg)
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder(TableFeaturePropType arg)
-
TableFeaturePropertiesBuilder
public TableFeaturePropertiesBuilder(TableFeatureProperties 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeaturePropType
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.Ordered
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public TableFeaturePropertiesKey key()
-
getOrder
public Integer getOrder()
-
getTableFeaturePropType
public TableFeaturePropType getTableFeaturePropType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public TableFeaturePropertiesBuilder withKey(TableFeaturePropertiesKey key)
-
setOrder
public TableFeaturePropertiesBuilder setOrder(Integer value)
-
setTableFeaturePropType
public TableFeaturePropertiesBuilder setTableFeaturePropType(TableFeaturePropType value)
-
addAugmentation
public TableFeaturePropertiesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties> augmentationValue)
-
removeAugmentation
public TableFeaturePropertiesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatureProperties>> augmentationType)
-
build
public TableFeatureProperties build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TableFeatureProperties>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TableFeatureProperties,IllegalArgumentException>
-
-