Class SrgbBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.vertex.SrgbBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Srgb>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Srgb,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SrgbBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Srgb>
Class that buildsSrgbBuilder
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:
SrgbBuilder createTarget(int fooXyzzy, int barBaz) { return new SrgbBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SrgbBuilder, 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:
SrgbBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SrgbBuilder()
SrgbBuilder(Srgb arg)
SrgbBuilder(Srgb base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SrgbBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Srgb> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Srgb>>
E$$augmentation(Class<E$$> augmentationType)
Srgb
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getLowerBound()
org.opendaylight.yangtools.yang.common.Uint32
getRangeSize()
SrgbBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Srgb>> augmentationType)
Remove an augmentation from this builder's product.SrgbBuilder
setLowerBound(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLowerBound(Uint32)
instead.SrgbBuilder
setLowerBound(org.opendaylight.yangtools.yang.common.Uint32 value)
SrgbBuilder
setRangeSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRangeSize(Uint32)
instead.SrgbBuilder
setRangeSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
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.graph.rev191125.Srgb
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLowerBound
public org.opendaylight.yangtools.yang.common.Uint32 getLowerBound()
-
getRangeSize
public org.opendaylight.yangtools.yang.common.Uint32 getRangeSize()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Srgb>> E$$ augmentation(Class<E$$> augmentationType)
-
setLowerBound
public SrgbBuilder setLowerBound(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setLowerBound
@Deprecated(forRemoval=true) public SrgbBuilder setLowerBound(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLowerBound(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setRangeSize
public SrgbBuilder setRangeSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setRangeSize
@Deprecated(forRemoval=true) public SrgbBuilder setRangeSize(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRangeSize(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public SrgbBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Srgb> 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 SrgbBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Srgb>> 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 Srgb build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Srgb>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Srgb,IllegalArgumentException>
-
-