Class StaleGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<StaleGroup>
,org.opendaylight.yangtools.concepts.CheckedBuilder<StaleGroup,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class StaleGroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<StaleGroup>
Class that buildsStaleGroup
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:
StaleGroup createStaleGroup(int fooXyzzy, int barBaz) { return new StaleGroupBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StaleGroup, 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:
StaleGroup
,Builder
-
-
Constructor Summary
Constructors Constructor Description StaleGroupBuilder()
StaleGroupBuilder(Group arg)
StaleGroupBuilder(StaleGroup base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StaleGroupBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StaleGroup> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleGroup>>
E$$augmentation(Class<E$$> augmentationType)
StaleGroup
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()
StaleGroupKey
key()
StaleGroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleGroup>> augmentationType)
Remove an augmentation from this builder's product.StaleGroupBuilder
setBarrier(Boolean value)
StaleGroupBuilder
setBuckets(Buckets value)
StaleGroupBuilder
setContainerName(String value)
StaleGroupBuilder
setGroupId(GroupId value)
StaleGroupBuilder
setGroupName(String value)
StaleGroupBuilder
setGroupType(GroupTypes value)
StaleGroupBuilder
withKey(StaleGroupKey key)
-
-
-
Constructor Detail
-
StaleGroupBuilder
public StaleGroupBuilder()
-
StaleGroupBuilder
public StaleGroupBuilder(Group arg)
-
StaleGroupBuilder
public StaleGroupBuilder(StaleGroup base)
-
-
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
-
key
public StaleGroupKey key()
-
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<StaleGroup>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public StaleGroupBuilder withKey(StaleGroupKey key)
-
setBarrier
public StaleGroupBuilder setBarrier(Boolean value)
-
setBuckets
public StaleGroupBuilder setBuckets(Buckets value)
-
setContainerName
public StaleGroupBuilder setContainerName(String value)
-
setGroupId
public StaleGroupBuilder setGroupId(GroupId value)
-
setGroupName
public StaleGroupBuilder setGroupName(String value)
-
setGroupType
public StaleGroupBuilder setGroupType(GroupTypes value)
-
addAugmentation
public StaleGroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StaleGroup> 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 StaleGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleGroup>> 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 StaleGroup build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<StaleGroup>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<StaleGroup,IllegalArgumentException>
-
-