Class GroupMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GroupMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GroupMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class GroupMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GroupMessage>
Class that buildsGroupMessageBuilder
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:
GroupMessageBuilder createTarget(int fooXyzzy, int barBaz) { return new GroupMessageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupMessageBuilder, 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:
GroupMessageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GroupMessageBuilder()
GroupMessageBuilder(Group arg)
GroupMessageBuilder(GroupMessage base)
GroupMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GroupMessageBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage>>
E$$augmentation(Class<E$$> augmentationType)
GroupMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Buckets
getBuckets()
GroupModCommand
getCommand()
String
getContainerName()
GroupId
getGroupId()
String
getGroupName()
GroupTypes
getGroupType()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
Boolean
isBarrier()
GroupMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage>> augmentationType)
GroupMessageBuilder
setBarrier(Boolean value)
GroupMessageBuilder
setBuckets(Buckets value)
GroupMessageBuilder
setCommand(GroupModCommand value)
GroupMessageBuilder
setContainerName(String value)
GroupMessageBuilder
setGroupId(GroupId value)
GroupMessageBuilder
setGroupName(String value)
GroupMessageBuilder
setGroupType(GroupTypes value)
GroupMessageBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.GroupMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
GroupMessageBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.GroupMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
GroupMessageBuilder
public GroupMessageBuilder()
-
GroupMessageBuilder
public GroupMessageBuilder(Group arg)
-
GroupMessageBuilder
public GroupMessageBuilder(OfHeader arg)
-
GroupMessageBuilder
public GroupMessageBuilder(GroupMessage 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.group.types.rev131018.Group
- 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
-
getBuckets
public Buckets getBuckets()
-
getCommand
public GroupModCommand getCommand()
-
getContainerName
public String getContainerName()
-
getGroupId
public GroupId getGroupId()
-
getGroupName
public String getGroupName()
-
getGroupType
public GroupTypes getGroupType()
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
-
isBarrier
public Boolean isBarrier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setBuckets
public GroupMessageBuilder setBuckets(Buckets value)
-
setCommand
public GroupMessageBuilder setCommand(GroupModCommand value)
-
setContainerName
public GroupMessageBuilder setContainerName(String value)
-
setGroupId
public GroupMessageBuilder setGroupId(GroupId value)
-
setGroupName
public GroupMessageBuilder setGroupName(String value)
-
setGroupType
public GroupMessageBuilder setGroupType(GroupTypes value)
-
setVersion
public GroupMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public GroupMessageBuilder 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 GroupMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public GroupMessageBuilder 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
-
setBarrier
public GroupMessageBuilder setBarrier(Boolean value)
-
addAugmentation
public GroupMessageBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage> augmentationValue)
-
removeAugmentation
public GroupMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage>> augmentationType)
-
build
public GroupMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GroupMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GroupMessage,IllegalArgumentException>
-
-