Class GetDpidFromInterfaceOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceOutputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GetDpidFromInterfaceOutput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GetDpidFromInterfaceOutput,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class GetDpidFromInterfaceOutputBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<GetDpidFromInterfaceOutput>
Class that buildsGetDpidFromInterfaceOutputBuilder
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:
GetDpidFromInterfaceOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new GetDpidFromInterfaceOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetDpidFromInterfaceOutputBuilder, 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:
GetDpidFromInterfaceOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GetDpidFromInterfaceOutputBuilder()
GetDpidFromInterfaceOutputBuilder(GetDpidFromInterfaceOutput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GetDpidFromInterfaceOutputBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.GetDpidFromInterfaceOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
GetDpidFromInterfaceOutput
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpid()
GetDpidFromInterfaceOutputBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput>> augmentationType)
Remove an augmentation from this builder's product.GetDpidFromInterfaceOutputBuilder
setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.GetDpidFromInterfaceOutputBuilder
setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
GetDpidFromInterfaceOutputBuilder
public GetDpidFromInterfaceOutputBuilder()
-
GetDpidFromInterfaceOutputBuilder
public GetDpidFromInterfaceOutputBuilder(GetDpidFromInterfaceOutput base)
-
-
Method Detail
-
getDpid
public org.opendaylight.yangtools.yang.common.Uint64 getDpid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setDpid
public GetDpidFromInterfaceOutputBuilder setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpid
@Deprecated(forRemoval=true) public GetDpidFromInterfaceOutputBuilder setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public GetDpidFromInterfaceOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput> 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 GetDpidFromInterfaceOutputBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput> 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 GetDpidFromInterfaceOutputBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetDpidFromInterfaceOutput>> 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 GetDpidFromInterfaceOutput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GetDpidFromInterfaceOutput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GetDpidFromInterfaceOutput,java.lang.IllegalArgumentException>
-
-