Class SidCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.sid.label.index.sid.label.index.SidCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SidCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SidCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SidCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SidCase>
Class that buildsSidCaseBuilder
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:
SidCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new SidCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SidCaseBuilder, 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:
SidCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SidCaseBuilder()
SidCaseBuilder(SidCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SidCaseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SidCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SidCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.SidCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SidCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SidCase>>
E$$augmentation(Class<E$$> augmentationType)
SidCase
build()
org.opendaylight.yangtools.yang.common.Uint32
getSid()
SidCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SidCase>> augmentationType)
Remove an augmentation from this builder's product.SidCaseBuilder
setSid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSid(Uint32)
instead.SidCaseBuilder
setSid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
SidCaseBuilder
public SidCaseBuilder()
-
SidCaseBuilder
public SidCaseBuilder(SidCase base)
-
-
Method Detail
-
getSid
public org.opendaylight.yangtools.yang.common.Uint32 getSid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SidCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setSid
public SidCaseBuilder setSid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSid
@Deprecated(forRemoval=true) public SidCaseBuilder setSid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSid(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public SidCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SidCase> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public SidCaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SidCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SidCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public SidCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SidCase>> 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 SidCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SidCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SidCase,IllegalArgumentException>
-
-