Class InternalToExternalPortMapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.info.router.ports.ports.InternalToExternalPortMapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InternalToExternalPortMap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InternalToExternalPortMap,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InternalToExternalPortMapBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<InternalToExternalPortMap>
Class that buildsInternalToExternalPortMapBuilder
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:
InternalToExternalPortMapBuilder createTarget(int fooXyzzy, int barBaz) { return new InternalToExternalPortMapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InternalToExternalPortMapBuilder, 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:
InternalToExternalPortMapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InternalToExternalPortMapBuilder()
InternalToExternalPortMapBuilder(InternalToExternalPortMap base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InternalToExternalPortMapBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.InternalToExternalPortMapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
InternalToExternalPortMap
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getExternalId()
java.lang.String
getExternalIp()
java.lang.String
getInternalIp()
org.opendaylight.yangtools.yang.common.Uint32
getLabel()
InternalToExternalPortMapKey
key()
InternalToExternalPortMapBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap>> augmentationType)
Remove an augmentation from this builder's product.InternalToExternalPortMapBuilder
setExternalId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
InternalToExternalPortMapBuilder
setExternalIp(java.lang.String value)
InternalToExternalPortMapBuilder
setInternalIp(java.lang.String value)
InternalToExternalPortMapBuilder
setLabel(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLabel(Uint32)
instead.InternalToExternalPortMapBuilder
setLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
InternalToExternalPortMapBuilder
withKey(InternalToExternalPortMapKey key)
-
-
-
Constructor Detail
-
InternalToExternalPortMapBuilder
public InternalToExternalPortMapBuilder()
-
InternalToExternalPortMapBuilder
public InternalToExternalPortMapBuilder(InternalToExternalPortMap base)
-
-
Method Detail
-
key
public InternalToExternalPortMapKey key()
-
getExternalId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getExternalId()
-
getExternalIp
public java.lang.String getExternalIp()
-
getInternalIp
public java.lang.String getInternalIp()
-
getLabel
public org.opendaylight.yangtools.yang.common.Uint32 getLabel()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public InternalToExternalPortMapBuilder withKey(InternalToExternalPortMapKey key)
-
setExternalId
public InternalToExternalPortMapBuilder setExternalId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setExternalIp
public InternalToExternalPortMapBuilder setExternalIp(java.lang.String value)
-
setInternalIp
public InternalToExternalPortMapBuilder setInternalIp(java.lang.String value)
-
setLabel
public InternalToExternalPortMapBuilder setLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setLabel
@Deprecated(forRemoval=true) public InternalToExternalPortMapBuilder setLabel(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLabel(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public InternalToExternalPortMapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap> 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 InternalToExternalPortMapBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap> 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 InternalToExternalPortMapBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalToExternalPortMap>> 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 InternalToExternalPortMap build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InternalToExternalPortMap>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InternalToExternalPortMap,java.lang.IllegalArgumentException>
-
-