Class AsGeneratedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.esi.as.generated._case.AsGeneratedBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AsGenerated>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AsGenerated,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AsGeneratedBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AsGenerated>
Class that buildsAsGeneratedBuilder
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:
AsGeneratedBuilder createTarget(int fooXyzzy, int barBaz) { return new AsGeneratedBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AsGeneratedBuilder, 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:
AsGeneratedBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AsGeneratedBuilder()
AsGeneratedBuilder(AsGenerated base)
AsGeneratedBuilder(LocalDiscriminator arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AsGeneratedBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated>>
E$$augmentation(Class<E$$> augmentationType)
AsGenerated
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getAs()
org.opendaylight.yangtools.yang.common.Uint32
getLocalDiscriminator()
AsGeneratedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated>> augmentationType)
AsGeneratedBuilder
setAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
AsGeneratedBuilder
setLocalDiscriminator(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setLocalDiscriminator(Uint32)} instead.AsGeneratedBuilder
setLocalDiscriminator(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
AsGeneratedBuilder
public AsGeneratedBuilder()
-
AsGeneratedBuilder
public AsGeneratedBuilder(LocalDiscriminator arg)
-
AsGeneratedBuilder
public AsGeneratedBuilder(AsGenerated 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.LocalDiscriminator
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getAs
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAs()
-
getLocalDiscriminator
public org.opendaylight.yangtools.yang.common.Uint32 getLocalDiscriminator()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated>> E$$ augmentation(Class<E$$> augmentationType)
-
setAs
public AsGeneratedBuilder setAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
setLocalDiscriminator
public AsGeneratedBuilder setLocalDiscriminator(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setLocalDiscriminator
@Deprecated(forRemoval=true) public AsGeneratedBuilder setLocalDiscriminator(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setLocalDiscriminator(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public AsGeneratedBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated> augmentationValue)
-
removeAugmentation
public AsGeneratedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsGenerated>> augmentationType)
-
build
public AsGenerated build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AsGenerated>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AsGenerated,IllegalArgumentException>
-
-