Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124
Class ControlBundleInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ControlBundleInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ControlBundleInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ControlBundleInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ControlBundleInput>
Class that buildsControlBundleInputBuilder
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:
ControlBundleInputBuilder createTarget(int fooXyzzy, int barBaz) { return new ControlBundleInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ControlBundleInputBuilder, 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:
ControlBundleInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ControlBundleInputBuilder()
ControlBundleInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
ControlBundleInputBuilder(ControlBundleInput base)
ControlBundleInputBuilder(BundleCommonGrouping arg)
ControlBundleInputBuilder(BundleControlGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ControlBundleInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.ControlBundleInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput>>
E$$augmentation(Class<E$$> augmentationType)
ControlBundleInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BundleId
getBundleId()
List<BundleProperty>
getBundleProperty()
BundleFlags
getFlags()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef
getNode()
BundleControlType
getType()
ControlBundleInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput>> augmentationType)
Remove an augmentation from this builder's product.ControlBundleInputBuilder
setBundleId(BundleId value)
ControlBundleInputBuilder
setBundleProperty(List<BundleProperty> values)
ControlBundleInputBuilder
setFlags(BundleFlags value)
ControlBundleInputBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
ControlBundleInputBuilder
setType(BundleControlType value)
-
-
-
Constructor Detail
-
ControlBundleInputBuilder
public ControlBundleInputBuilder()
-
ControlBundleInputBuilder
public ControlBundleInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
ControlBundleInputBuilder
public ControlBundleInputBuilder(BundleControlGrouping arg)
-
ControlBundleInputBuilder
public ControlBundleInputBuilder(BundleCommonGrouping arg)
-
ControlBundleInputBuilder
public ControlBundleInputBuilder(ControlBundleInput 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.inventory.rev130819.NodeContextRef
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleCommonGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleControlGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getBundleId
public BundleId getBundleId()
-
getBundleProperty
public List<BundleProperty> getBundleProperty()
-
getFlags
public BundleFlags getFlags()
-
getNode
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
-
getType
public BundleControlType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setBundleId
public ControlBundleInputBuilder setBundleId(BundleId value)
-
setBundleProperty
public ControlBundleInputBuilder setBundleProperty(List<BundleProperty> values)
-
setFlags
public ControlBundleInputBuilder setFlags(BundleFlags value)
-
setNode
public ControlBundleInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
setType
public ControlBundleInputBuilder setType(BundleControlType value)
-
addAugmentation
public ControlBundleInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public ControlBundleInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public ControlBundleInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlBundleInput>> 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 ControlBundleInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ControlBundleInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ControlBundleInput,IllegalArgumentException>
-
-