Class OriginalGroupBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.OriginalGroupBuilder
Class that builds
OriginalGroup
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:
OriginalGroup createOriginalGroup(int fooXyzzy, int barBaz) {
return new OriginalGroupBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of OriginalGroup, 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.Construct a builder initialized with state from specifiedOriginalGroup
.Construct a new builder initialized from specifiedGroup
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<OriginalGroup> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalGroup>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull OriginalGroup
build()
A newOriginalGroup
instance.static @NonNull OriginalGroup
empty()
Get empty instance of OriginalGroup.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()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalGroup>> 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.
-
Constructor Details
-
OriginalGroupBuilder
public OriginalGroupBuilder()Construct an empty builder. -
OriginalGroupBuilder
Construct a new builder initialized from specifiedGroup
.- Parameters:
arg
- Group from which the builder should be initialized
-
OriginalGroupBuilder
Construct a builder initialized with state from specifiedOriginalGroup
.- Parameters:
base
- OriginalGroup 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
-
empty
Get empty instance of OriginalGroup.- Returns:
- An empty
OriginalGroup
-
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<OriginalGroup>> 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
-
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 OriginalGroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OriginalGroup> 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 OriginalGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalGroup>> 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 newOriginalGroup
instance.- Returns:
- A new
OriginalGroup
instance.
-