Class GroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Group>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Group,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class GroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Group>
Class that buildsGroupBuilder
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:
GroupBuilder createTarget(int fooXyzzy, int barBaz) { return new GroupBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupBuilder, 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:
GroupBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GroupBuilder()
GroupBuilder(Group arg)
GroupBuilder(Group base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Group> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>>
E$$augmentation(Class<E$$> augmentationType)
Group
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Buckets
getBuckets()
String
getContainerName()
GroupId
getGroupId()
String
getGroupName()
GroupTypes
getGroupType()
Boolean
isBarrier()
GroupKey
key()
GroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> augmentationType)
GroupBuilder
setBarrier(Boolean value)
GroupBuilder
setBuckets(Buckets value)
GroupBuilder
setContainerName(String value)
GroupBuilder
setGroupId(GroupId value)
GroupBuilder
setGroupName(String value)
GroupBuilder
setGroupType(GroupTypes value)
GroupBuilder
withKey(GroupKey key)
-
-
-
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
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public GroupKey key()
-
getBuckets
public Buckets getBuckets()
-
getContainerName
public String getContainerName()
-
getGroupId
public GroupId getGroupId()
-
getGroupName
public String getGroupName()
-
getGroupType
public GroupTypes getGroupType()
-
isBarrier
public Boolean isBarrier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public GroupBuilder withKey(GroupKey key)
-
setBuckets
public GroupBuilder setBuckets(Buckets value)
-
setContainerName
public GroupBuilder setContainerName(String value)
-
setGroupId
public GroupBuilder setGroupId(GroupId value)
-
setGroupName
public GroupBuilder setGroupName(String value)
-
setGroupType
public GroupBuilder setGroupType(GroupTypes value)
-
setBarrier
public GroupBuilder setBarrier(Boolean value)
-
addAugmentation
public GroupBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Group> augmentationValue)
-
removeAugmentation
public GroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> augmentationType)
-
build
public Group build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Group>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Group,IllegalArgumentException>
-
-