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