Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.router.to.vpn.mapping
Class RoutermappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.router.to.vpn.mapping.RoutermappingBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Routermapping>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Routermapping,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RoutermappingBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Routermapping>
Class that buildsRoutermappingBuilder
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:
RoutermappingBuilder createTarget(int fooXyzzy, int barBaz) { return new RoutermappingBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoutermappingBuilder, 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:
RoutermappingBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RoutermappingBuilder()
RoutermappingBuilder(Routermapping base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RoutermappingBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Routermapping
build()
java.lang.String
getRouterName()
org.opendaylight.yangtools.yang.common.Uint32
getVpnId()
java.lang.String
getVpnName()
RoutermappingKey
key()
RoutermappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping>> augmentationType)
RoutermappingBuilder
setRouterName(java.lang.String value)
RoutermappingBuilder
setVpnId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVpnId(Uint32)} instead.RoutermappingBuilder
setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
RoutermappingBuilder
setVpnName(java.lang.String value)
RoutermappingBuilder
withKey(RoutermappingKey key)
-
-
-
Constructor Detail
-
RoutermappingBuilder
public RoutermappingBuilder()
-
RoutermappingBuilder
public RoutermappingBuilder(Routermapping base)
-
-
Method Detail
-
key
public RoutermappingKey key()
-
getRouterName
public java.lang.String getRouterName()
-
getVpnId
public org.opendaylight.yangtools.yang.common.Uint32 getVpnId()
-
getVpnName
public java.lang.String getVpnName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public RoutermappingBuilder withKey(RoutermappingKey key)
-
setRouterName
public RoutermappingBuilder setRouterName(java.lang.String value)
-
setVpnId
public RoutermappingBuilder setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setVpnId
@Deprecated(forRemoval=true) public RoutermappingBuilder setVpnId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVpnId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVpnName
public RoutermappingBuilder setVpnName(java.lang.String value)
-
addAugmentation
public RoutermappingBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping> augmentationValue)
-
removeAugmentation
public RoutermappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routermapping>> augmentationType)
-
build
public Routermapping build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Routermapping>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Routermapping,java.lang.IllegalArgumentException>
-
-