Class InstanceIdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.InstanceIdBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InstanceId>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InstanceId,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InstanceIdBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<InstanceId>
Class that buildsInstanceIdBuilder
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:
InstanceIdBuilder createTarget(int fooXyzzy, int barBaz) { return new InstanceIdBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InstanceIdBuilder, 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:
InstanceIdBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InstanceIdBuilder()
InstanceIdBuilder(InstanceId base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InstanceIdBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.InstanceIdBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
InstanceId
build()
InstanceId
getInstanceId()
InstanceIdBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> augmentationType)
Remove an augmentation from this builder's product.InstanceIdBuilder
setInstanceId(InstanceId value)
-
-
-
Constructor Detail
-
InstanceIdBuilder
public InstanceIdBuilder()
-
InstanceIdBuilder
public InstanceIdBuilder(InstanceId base)
-
-
Method Detail
-
getInstanceId
public InstanceId getInstanceId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setInstanceId
public InstanceIdBuilder setInstanceId(InstanceId value)
-
addAugmentation
public InstanceIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public InstanceIdBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId> 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 InstanceIdBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> 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 InstanceId build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InstanceId>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InstanceId,java.lang.IllegalArgumentException>
-
-