Class VpnPortipToPortBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnPortipToPort>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnPortipToPort,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnPortipToPortBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnPortipToPort>
Class that buildsVpnPortipToPortBuilder
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:
VpnPortipToPortBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnPortipToPortBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnPortipToPortBuilder, 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:
VpnPortipToPortBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnPortipToPortBuilder()
VpnPortipToPortBuilder(VpnPortipToPort base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnPortipToPortBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnPortipToPort> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnPortipToPort>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnPortipToPort
build()
java.lang.Boolean
getLearntIp()
java.lang.String
getMacAddress()
java.lang.String
getPortFixedip()
java.lang.String
getPortName()
java.lang.Boolean
getSubnetIp()
java.lang.String
getVpnName()
java.lang.Boolean
isLearntIp()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isSubnetIp()
Deprecated, for removal: This API element is subject to removal in a future version.VpnPortipToPortKey
key()
VpnPortipToPortBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnPortipToPort>> augmentationType)
Remove an augmentation from this builder's product.VpnPortipToPortBuilder
setLearntIp(java.lang.Boolean value)
VpnPortipToPortBuilder
setMacAddress(java.lang.String value)
VpnPortipToPortBuilder
setPortFixedip(java.lang.String value)
VpnPortipToPortBuilder
setPortName(java.lang.String value)
VpnPortipToPortBuilder
setSubnetIp(java.lang.Boolean value)
VpnPortipToPortBuilder
setVpnName(java.lang.String value)
VpnPortipToPortBuilder
withKey(VpnPortipToPortKey key)
-
-
-
Constructor Detail
-
VpnPortipToPortBuilder
public VpnPortipToPortBuilder()
-
VpnPortipToPortBuilder
public VpnPortipToPortBuilder(VpnPortipToPort base)
-
-
Method Detail
-
key
public VpnPortipToPortKey key()
-
getLearntIp
public java.lang.Boolean getLearntIp()
-
isLearntIp
@Deprecated(forRemoval=true) public final java.lang.Boolean isLearntIp()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getMacAddress
public java.lang.String getMacAddress()
-
getPortFixedip
public java.lang.String getPortFixedip()
-
getPortName
public java.lang.String getPortName()
-
getSubnetIp
public java.lang.Boolean getSubnetIp()
-
isSubnetIp
@Deprecated(forRemoval=true) public final java.lang.Boolean isSubnetIp()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getVpnName
public java.lang.String getVpnName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnPortipToPort>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnPortipToPortBuilder withKey(VpnPortipToPortKey key)
-
setLearntIp
public VpnPortipToPortBuilder setLearntIp(java.lang.Boolean value)
-
setMacAddress
public VpnPortipToPortBuilder setMacAddress(java.lang.String value)
-
setPortFixedip
public VpnPortipToPortBuilder setPortFixedip(java.lang.String value)
-
setPortName
public VpnPortipToPortBuilder setPortName(java.lang.String value)
-
setSubnetIp
public VpnPortipToPortBuilder setSubnetIp(java.lang.Boolean value)
-
setVpnName
public VpnPortipToPortBuilder setVpnName(java.lang.String value)
-
addAugmentation
public VpnPortipToPortBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnPortipToPort> 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
-
removeAugmentation
public VpnPortipToPortBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnPortipToPort>> 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 VpnPortipToPort build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnPortipToPort>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnPortipToPort,java.lang.IllegalArgumentException>
-
-