Class GroupBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder
Class that builds
Group
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:
-
Constructor Summary
ConstructorDescriptionConstruct 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
Modifier and TypeMethodDescriptionaddAugmentation
(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.Return current value associated with the property corresponding toGroup.getBarrier()
.Return current value associated with the property corresponding toGroup.getBuckets()
.Return current value associated with the property corresponding toGroup.getContainerName()
.Return current value associated with the property corresponding toGroup.getGroupId()
.Return current value associated with the property corresponding toGroup.getGroupName()
.Return current value associated with the property corresponding toGroup.getGroupType()
.key()
Return current value associated with the property corresponding toGroup.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Group>> augmentationType) Remove an augmentation from this builder's product.setBarrier
(Boolean value) Set the property corresponding toGroup.getBarrier()
to the specified value.setBuckets
(Buckets value) Set the property corresponding toGroup.getBuckets()
to the specified value.setContainerName
(String value) Set the property corresponding toGroup.getContainerName()
to the specified value.setGroupId
(GroupId value) Set the property corresponding toGroup.getGroupId()
to the specified value.setGroupName
(String value) Set the property corresponding toGroup.getGroupName()
to the specified value.setGroupType
(GroupTypes value) Set the property corresponding toGroup.getGroupType()
to the specified value.Set the key value corresponding toGroup.key()
to the specified value.
-
Constructor Details
-
GroupBuilder
public GroupBuilder()Construct an empty builder. -
GroupBuilder
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
-
GroupBuilder
Construct a builder initialized with state from specifiedGroup
.- Parameters:
base
- Group from which the builder should be initialized
-
-
Method Details
-
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
Return current value associated with the property corresponding toGroup.key()
.- Returns:
- current value
-
getBarrier
Return current value associated with the property corresponding toGroup.getBarrier()
.- Returns:
- current value
-
getBuckets
Return current value associated with the property corresponding toGroup.getBuckets()
.- Returns:
- current value
-
getContainerName
Return current value associated with the property corresponding toGroup.getContainerName()
.- Returns:
- current value
-
getGroupId
Return current value associated with the property corresponding toGroup.getGroupId()
.- Returns:
- current value
-
getGroupName
Return current value associated with the property corresponding toGroup.getGroupName()
.- Returns:
- current value
-
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
Set the key value corresponding toGroup.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setBarrier
Set the property corresponding toGroup.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBuckets
Set the property corresponding toGroup.getBuckets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
Set the property corresponding toGroup.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupId
Set the property corresponding toGroup.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupName
Set the property corresponding toGroup.getGroupName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupType
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
-
build
A newGroup
instance.- Returns:
- A new
Group
instance.
-