Class GroupDescBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.desc.GroupDescBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GroupDesc>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GroupDesc,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class GroupDescBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GroupDesc>
Class that buildsGroupDesc
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:
GroupDesc createGroupDesc(int fooXyzzy, int barBaz) { return new GroupDescBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupDesc, 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 opportunities, 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:
GroupDesc
,Builder
-
-
Constructor Summary
Constructors Constructor Description GroupDescBuilder()
GroupDescBuilder(GroupDesc base)
GroupDescBuilder(Group arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupDescBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>>
E$$augmentation(Class<E$$> augmentationType)
GroupDesc
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
Buckets
getBuckets()
String
getContainerName()
GroupId
getGroupId()
String
getGroupName()
GroupTypes
getGroupType()
GroupDescBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>> augmentationType)
Remove an augmentation from this builder's product.GroupDescBuilder
setBarrier(Boolean value)
GroupDescBuilder
setBuckets(Buckets value)
GroupDescBuilder
setContainerName(String value)
GroupDescBuilder
setGroupId(GroupId value)
GroupDescBuilder
setGroupName(String value)
GroupDescBuilder
setGroupType(GroupTypes value)
-
-
-
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:- Group
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBarrier
public Boolean getBarrier()
-
getBuckets
public Buckets getBuckets()
-
getContainerName
public String getContainerName()
-
getGroupId
public GroupId getGroupId()
-
getGroupName
public String getGroupName()
-
getGroupType
public GroupTypes getGroupType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public GroupDescBuilder setBarrier(Boolean value)
-
setBuckets
public GroupDescBuilder setBuckets(Buckets value)
-
setContainerName
public GroupDescBuilder setContainerName(String value)
-
setGroupId
public GroupDescBuilder setGroupId(GroupId value)
-
setGroupName
public GroupDescBuilder setGroupName(String value)
-
setGroupType
public GroupDescBuilder setGroupType(GroupTypes value)
-
addAugmentation
public GroupDescBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public GroupDescBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupDesc>> 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 GroupDesc build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GroupDesc>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GroupDesc,IllegalArgumentException>
-
-