Class DynamicControlProtectionCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.record.route.subobjects.subobject.type.DynamicControlProtectionCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DynamicControlProtectionCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DynamicControlProtectionCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DynamicControlProtectionCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<DynamicControlProtectionCase>
Class that buildsDynamicControlProtectionCaseBuilder
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:
DynamicControlProtectionCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new DynamicControlProtectionCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DynamicControlProtectionCaseBuilder, 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:
DynamicControlProtectionCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DynamicControlProtectionCaseBuilder()
DynamicControlProtectionCaseBuilder(DynamicControlProtectionCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DynamicControlProtectionCaseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DynamicControlProtectionCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase>>
E$$augmentation(Class<E$$> augmentationType)
DynamicControlProtectionCase
build()
DynamicControlProtection
getDynamicControlProtection()
DynamicControlProtectionCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase>> augmentationType)
Remove an augmentation from this builder's product.DynamicControlProtectionCaseBuilder
setDynamicControlProtection(DynamicControlProtection value)
-
-
-
Constructor Detail
-
DynamicControlProtectionCaseBuilder
public DynamicControlProtectionCaseBuilder()
-
DynamicControlProtectionCaseBuilder
public DynamicControlProtectionCaseBuilder(DynamicControlProtectionCase base)
-
-
Method Detail
-
getDynamicControlProtection
public DynamicControlProtection getDynamicControlProtection()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setDynamicControlProtection
public DynamicControlProtectionCaseBuilder setDynamicControlProtection(DynamicControlProtection value)
-
addAugmentation
public DynamicControlProtectionCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase> 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 DynamicControlProtectionCaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase> 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 DynamicControlProtectionCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtectionCase>> 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 DynamicControlProtectionCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DynamicControlProtectionCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DynamicControlProtectionCase,IllegalArgumentException>
-
-