Class TagSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.tag.set.TagSetBuilder
-
@Generated("mdsal-binding-generator") public class TagSetBuilder extends Object
Class that buildsTagSet
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:
TagSet createTagSet(int fooXyzzy, int barBaz) { return new TagSetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TagSet, 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:
TagSet
- 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 TagSetBuilder()
Construct an empty builder.TagSetBuilder(TagSet base)
Construct a builder initialized with state from specifiedTagSet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TagSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TagSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TagSet>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TagSet
build()
A newTagSet
instance.Map<TagKey,Tag>
getTag()
Return current value associated with the property corresponding toTagSet.getTag()
.String
getTagSetName()
Return current value associated with the property corresponding toTagSet.getTagSetName()
.TagSetKey
key()
Return current value associated with the property corresponding toTagSet.key()
.TagSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TagSet>> augmentationType)
Remove an augmentation from this builder's product.TagSetBuilder
setTag(Map<TagKey,Tag> values)
Set the property corresponding toTagSet.getTag()
to the specified value.TagSetBuilder
setTagSetName(String value)
Set the property corresponding toTagSet.getTagSetName()
to the specified value.TagSetBuilder
withKey(TagSetKey key)
-
-
-
Method Detail
-
key
public TagSetKey key()
Return current value associated with the property corresponding toTagSet.key()
.- Returns:
- current value
-
getTag
public Map<TagKey,Tag> getTag()
Return current value associated with the property corresponding toTagSet.getTag()
.- Returns:
- current value
-
getTagSetName
public String getTagSetName()
Return current value associated with the property corresponding toTagSet.getTagSetName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TagSet>> 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 TagSetBuilder withKey(TagSetKey key)
-
setTag
public TagSetBuilder setTag(Map<TagKey,Tag> values)
Set the property corresponding toTagSet.getTag()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setTagSetName
public TagSetBuilder setTagSetName(String value)
Set the property corresponding toTagSet.getTagSetName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TagSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TagSet> 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 TagSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TagSet>> 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
-
-