Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.tag.set.tag.set
Class TagBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.tag.set.tag.set.TagBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Tag>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Tag,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TagBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Tag>
Class that buildsTagBuilder
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:
TagBuilder createTarget(int fooXyzzy, int barBaz) { return new TagBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TagBuilder, 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 oportunities, 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:
TagBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TagBuilder()
TagBuilder(Tag base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TagBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tag>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Tag> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tag>>
E$$augmentation(Class<E$$> augmentationType)
Tag
build()
TagType
getValue()
TagKey
key()
TagBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tag>> augmentationType)
TagBuilder
setValue(TagType value)
TagBuilder
withKey(TagKey key)
-
-
-
Constructor Detail
-
TagBuilder
public TagBuilder()
-
TagBuilder
public TagBuilder(Tag base)
-
-
Method Detail
-
key
public TagKey key()
-
getValue
public TagType getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tag>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public TagBuilder withKey(TagKey key)
-
setValue
public TagBuilder setValue(TagType value)
-
addAugmentation
public TagBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tag>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Tag> augmentationValue)
-
removeAugmentation
public TagBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tag>> augmentationType)
-
build
public Tag build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Tag>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Tag,IllegalArgumentException>
-
-