Class GroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder
-
@Generated("mdsal-binding-generator") public class GroupBuilder extends Object
Class that buildsGroup
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:
Group createGroup(int fooXyzzy, int barBaz) { return new GroupBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Group, 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:
Group
- 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
-
-
Constructor Summary
Constructors Constructor Description GroupBuilder()
Construct an empty builder.GroupBuilder(Group arg)
Construct a new builder initialized from specifiedGroup
.GroupBuilder(Group base)
Construct a builder initialized with state from specifiedGroup
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Group> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Group
build()
A newGroup
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
Return current value associated with the property corresponding toGroup.getBarrier()
.Buckets
getBuckets()
Return current value associated with the property corresponding toGroup.getBuckets()
.String
getContainerName()
Return current value associated with the property corresponding toGroup.getContainerName()
.GroupId
getGroupId()
Return current value associated with the property corresponding toGroup.getGroupId()
.String
getGroupName()
Return current value associated with the property corresponding toGroup.getGroupName()
.GroupTypes
getGroupType()
Return current value associated with the property corresponding toGroup.getGroupType()
.GroupKey
key()
Return current value associated with the property corresponding toGroup.key()
.GroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> augmentationType)
Remove an augmentation from this builder's product.GroupBuilder
setBarrier(Boolean value)
Set the property corresponding toGroup.getBarrier()
to the specified value.GroupBuilder
setBuckets(Buckets value)
Set the property corresponding toGroup.getBuckets()
to the specified value.GroupBuilder
setContainerName(String value)
Set the property corresponding toGroup.getContainerName()
to the specified value.GroupBuilder
setGroupId(GroupId value)
Set the property corresponding toGroup.getGroupId()
to the specified value.GroupBuilder
setGroupName(String value)
Set the property corresponding toGroup.getGroupName()
to the specified value.GroupBuilder
setGroupType(GroupTypes value)
Set the property corresponding toGroup.getGroupType()
to the specified value.GroupBuilder
withKey(GroupKey key)
-
-
-
Constructor Detail
-
GroupBuilder
public GroupBuilder()
Construct an empty builder.
-
GroupBuilder
public GroupBuilder(Group arg)
Construct a new builder initialized from specifiedGroup
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.Group from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public GroupKey key()
Return current value associated with the property corresponding toGroup.key()
.- Returns:
- current value
-
getBarrier
public Boolean getBarrier()
Return current value associated with the property corresponding toGroup.getBarrier()
.- Returns:
- current value
-
getBuckets
public Buckets getBuckets()
Return current value associated with the property corresponding toGroup.getBuckets()
.- Returns:
- current value
-
getContainerName
public String getContainerName()
Return current value associated with the property corresponding toGroup.getContainerName()
.- Returns:
- current value
-
getGroupId
public GroupId getGroupId()
Return current value associated with the property corresponding toGroup.getGroupId()
.- Returns:
- current value
-
getGroupName
public String getGroupName()
Return current value associated with the property corresponding toGroup.getGroupName()
.- Returns:
- current value
-
getGroupType
public GroupTypes getGroupType()
Return current value associated with the property corresponding toGroup.getGroupType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public GroupBuilder withKey(GroupKey key)
-
setBarrier
public GroupBuilder setBarrier(Boolean value)
Set the property corresponding toGroup.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBuckets
public GroupBuilder setBuckets(Buckets value)
Set the property corresponding toGroup.getBuckets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
public GroupBuilder setContainerName(String value)
Set the property corresponding toGroup.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupId
public GroupBuilder setGroupId(GroupId value)
Set the property corresponding toGroup.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupName
public GroupBuilder setGroupName(String value)
Set the property corresponding toGroup.getGroupName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupType
public GroupBuilder setGroupType(GroupTypes value)
Set the property corresponding toGroup.getGroupType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Group> 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 GroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> 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
-
-