Class GroupModCaseDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.group.mod._case.GroupModCaseDataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GroupModCaseData>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GroupModCaseData,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class GroupModCaseDataBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GroupModCaseData>
Class that buildsGroupModCaseDataBuilder
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:
GroupModCaseDataBuilder createTarget(int fooXyzzy, int barBaz) { return new GroupModCaseDataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupModCaseDataBuilder, 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:
GroupModCaseDataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GroupModCaseDataBuilder()
GroupModCaseDataBuilder(BucketsGrouping arg)
GroupModCaseDataBuilder(GroupMod arg)
GroupModCaseDataBuilder(OfHeader arg)
GroupModCaseDataBuilder(GroupModCaseData base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GroupModCaseDataBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupModCaseData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GroupModCaseData> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupModCaseData>>
E$$augmentation(Class<E$$> augmentationType)
GroupModCaseData
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<BucketsList>
getBucketsList()
GroupModCommand
getCommand()
GroupId
getGroupId()
GroupType
getType()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
GroupModCaseDataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupModCaseData>> augmentationType)
GroupModCaseDataBuilder
setBucketsList(List<BucketsList> values)
GroupModCaseDataBuilder
setCommand(GroupModCommand value)
GroupModCaseDataBuilder
setGroupId(GroupId value)
GroupModCaseDataBuilder
setType(GroupType value)
GroupModCaseDataBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.GroupModCaseDataBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
GroupModCaseDataBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.GroupModCaseDataBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
GroupModCaseDataBuilder
public GroupModCaseDataBuilder()
-
GroupModCaseDataBuilder
public GroupModCaseDataBuilder(GroupMod arg)
-
GroupModCaseDataBuilder
public GroupModCaseDataBuilder(OfHeader arg)
-
GroupModCaseDataBuilder
public GroupModCaseDataBuilder(BucketsGrouping arg)
-
GroupModCaseDataBuilder
public GroupModCaseDataBuilder(GroupModCaseData 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.openflow.protocol.rev130731.GroupMod
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BucketsGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getBucketsList
public List<BucketsList> getBucketsList()
-
getCommand
public GroupModCommand getCommand()
-
getGroupId
public GroupId getGroupId()
-
getType
public GroupType getType()
-
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<GroupModCaseData>> E$$ augmentation(Class<E$$> augmentationType)
-
setBucketsList
public GroupModCaseDataBuilder setBucketsList(List<BucketsList> values)
-
setCommand
public GroupModCaseDataBuilder setCommand(GroupModCommand value)
-
setGroupId
public GroupModCaseDataBuilder setGroupId(GroupId value)
-
setType
public GroupModCaseDataBuilder setType(GroupType value)
-
setVersion
public GroupModCaseDataBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public GroupModCaseDataBuilder setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setXid
public GroupModCaseDataBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public GroupModCaseDataBuilder setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public GroupModCaseDataBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupModCaseData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GroupModCaseData> augmentationValue)
-
removeAugmentation
public GroupModCaseDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupModCaseData>> augmentationType)
-
build
public GroupModCaseData build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GroupModCaseData>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GroupModCaseData,IllegalArgumentException>
-
-