Class SrgbValueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.originator.srgb.tlv.SrgbValueBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SrgbValue>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SrgbValue,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SrgbValueBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SrgbValue>
Class that buildsSrgbValueBuilder
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:
SrgbValueBuilder createTarget(int fooXyzzy, int barBaz) { return new SrgbValueBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SrgbValueBuilder, 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:
SrgbValueBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SrgbValueBuilder()
SrgbValueBuilder(SrgbValue base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SrgbValueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrgbValue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrgbValue>>
E$$augmentation(Class<E$$> augmentationType)
SrgbValue
build()
Srgb
getBase()
Srgb
getRange()
SrgbValueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrgbValue>> augmentationType)
Remove an augmentation from this builder's product.SrgbValueBuilder
setBase(Srgb value)
SrgbValueBuilder
setRange(Srgb value)
-
-
-
Constructor Detail
-
SrgbValueBuilder
public SrgbValueBuilder()
-
SrgbValueBuilder
public SrgbValueBuilder(SrgbValue base)
-
-
Method Detail
-
getBase
public Srgb getBase()
-
getRange
public Srgb getRange()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrgbValue>> E$$ augmentation(Class<E$$> augmentationType)
-
setBase
public SrgbValueBuilder setBase(Srgb value)
-
setRange
public SrgbValueBuilder setRange(Srgb value)
-
addAugmentation
public SrgbValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrgbValue> 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 SrgbValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrgbValue>> 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 SrgbValue build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SrgbValue>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SrgbValue,IllegalArgumentException>
-
-