Class GroupFeaturesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.group.features.GroupFeaturesBuilder
-
@Generated("mdsal-binding-generator") public class GroupFeaturesBuilder extends Object
Class that buildsGroupFeatures
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:
GroupFeatures createGroupFeatures(int fooXyzzy, int barBaz) { return new GroupFeaturesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GroupFeatures, 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:
GroupFeatures
- 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 GroupFeaturesBuilder()
Construct an empty builder.GroupFeaturesBuilder(GroupFeatures base)
Construct a builder initialized with state from specifiedGroupFeatures
.GroupFeaturesBuilder(GroupFeatures arg)
Construct a new builder initialized from specifiedGroupFeatures
.GroupFeaturesBuilder(GroupFeaturesReply arg)
Construct a new builder initialized from specifiedGroupFeaturesReply
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupFeaturesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupFeatures> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupFeatures>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull GroupFeatures
build()
A newGroupFeatures
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<org.opendaylight.yangtools.yang.common.Uint32>
getActions()
Return current value associated with the property corresponding toGroupFeatures.getActions()
.Set<Class<? extends GroupCapability>>
getGroupCapabilitiesSupported()
Return current value associated with the property corresponding toGroupFeatures.getGroupCapabilitiesSupported()
.Set<Class<? extends GroupType>>
getGroupTypesSupported()
Return current value associated with the property corresponding toGroupFeatures.getGroupTypesSupported()
.List<org.opendaylight.yangtools.yang.common.Uint32>
getMaxGroups()
Return current value associated with the property corresponding toGroupFeatures.getMaxGroups()
.GroupFeaturesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupFeatures>> augmentationType)
Remove an augmentation from this builder's product.GroupFeaturesBuilder
setActions(List<org.opendaylight.yangtools.yang.common.Uint32> values)
Set the property corresponding toGroupFeatures.getActions()
to the specified value.GroupFeaturesBuilder
setGroupCapabilitiesSupported(Set<Class<? extends GroupCapability>> values)
Set the property corresponding toGroupFeatures.getGroupCapabilitiesSupported()
to the specified value.GroupFeaturesBuilder
setGroupTypesSupported(Set<Class<? extends GroupType>> values)
Set the property corresponding toGroupFeatures.getGroupTypesSupported()
to the specified value.GroupFeaturesBuilder
setMaxGroups(List<org.opendaylight.yangtools.yang.common.Uint32> values)
Set the property corresponding toGroupFeatures.getMaxGroups()
to the specified value.
-
-
-
Constructor Detail
-
GroupFeaturesBuilder
public GroupFeaturesBuilder()
Construct an empty builder.
-
GroupFeaturesBuilder
public GroupFeaturesBuilder(GroupFeaturesReply arg)
Construct a new builder initialized from specifiedGroupFeaturesReply
.- Parameters:
arg
- GroupFeaturesReply from which the builder should be initialized
-
GroupFeaturesBuilder
public GroupFeaturesBuilder(GroupFeatures arg)
Construct a new builder initialized from specifiedGroupFeatures
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupFeatures from which the builder should be initialized
-
GroupFeaturesBuilder
public GroupFeaturesBuilder(GroupFeatures base)
Construct a builder initialized with state from specifiedGroupFeatures
.- Parameters:
base
- GroupFeatures 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
-
getActions
public List<org.opendaylight.yangtools.yang.common.Uint32> getActions()
Return current value associated with the property corresponding toGroupFeatures.getActions()
.- Returns:
- current value
-
getGroupCapabilitiesSupported
public Set<Class<? extends GroupCapability>> getGroupCapabilitiesSupported()
Return current value associated with the property corresponding toGroupFeatures.getGroupCapabilitiesSupported()
.- Returns:
- current value
-
getGroupTypesSupported
public Set<Class<? extends GroupType>> getGroupTypesSupported()
Return current value associated with the property corresponding toGroupFeatures.getGroupTypesSupported()
.- Returns:
- current value
-
getMaxGroups
public List<org.opendaylight.yangtools.yang.common.Uint32> getMaxGroups()
Return current value associated with the property corresponding toGroupFeatures.getMaxGroups()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupFeatures>> 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
-
setActions
public GroupFeaturesBuilder setActions(List<org.opendaylight.yangtools.yang.common.Uint32> values)
Set the property corresponding toGroupFeatures.getActions()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setGroupCapabilitiesSupported
public GroupFeaturesBuilder setGroupCapabilitiesSupported(Set<Class<? extends GroupCapability>> values)
Set the property corresponding toGroupFeatures.getGroupCapabilitiesSupported()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setGroupTypesSupported
public GroupFeaturesBuilder setGroupTypesSupported(Set<Class<? extends GroupType>> values)
Set the property corresponding toGroupFeatures.getGroupTypesSupported()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMaxGroups
public GroupFeaturesBuilder setMaxGroups(List<org.opendaylight.yangtools.yang.common.Uint32> values)
Set the property corresponding toGroupFeatures.getMaxGroups()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public GroupFeaturesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GroupFeatures> 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 GroupFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupFeatures>> 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 @NonNull GroupFeatures build()
A newGroupFeatures
instance.- Returns:
- A new
GroupFeatures
instance.
-
-