Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.srlg.attributes
Class SrlgValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.srlg.attributes.SrlgValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SrlgValues>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SrlgValues,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SrlgValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SrlgValues>
Class that buildsSrlgValuesBuilder
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:
SrlgValuesBuilder createTarget(int fooXyzzy, int barBaz) { return new SrlgValuesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SrlgValuesBuilder, 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:
SrlgValuesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SrlgValuesBuilder()
SrlgValuesBuilder(SrlgValues base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SrlgValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>>
E$$augmentation(Class<E$$> augmentationType)
SrlgValues
build()
org.opendaylight.yangtools.yang.common.Uint32
getSrlgValue()
SrlgValuesKey
key()
SrlgValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>> augmentationType)
Remove an augmentation from this builder's product.SrlgValuesBuilder
setSrlgValue(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrlgValue(Uint32)
instead.SrlgValuesBuilder
setSrlgValue(org.opendaylight.yangtools.yang.common.Uint32 value)
SrlgValuesBuilder
withKey(SrlgValuesKey key)
-
-
-
Constructor Detail
-
SrlgValuesBuilder
public SrlgValuesBuilder()
-
SrlgValuesBuilder
public SrlgValuesBuilder(SrlgValues base)
-
-
Method Detail
-
key
public SrlgValuesKey key()
-
getSrlgValue
public org.opendaylight.yangtools.yang.common.Uint32 getSrlgValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SrlgValuesBuilder withKey(SrlgValuesKey key)
-
setSrlgValue
public SrlgValuesBuilder setSrlgValue(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSrlgValue
@Deprecated(forRemoval=true) public SrlgValuesBuilder setSrlgValue(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSrlgValue(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public SrlgValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues> 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 SrlgValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>> 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 SrlgValues build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SrlgValues>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SrlgValues,IllegalArgumentException>
-
-