Class PortIdToSubportBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.port.id.subport.data.PortIdToSubportBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PortIdToSubport>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PortIdToSubport,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PortIdToSubportBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<PortIdToSubport>
Class that buildsPortIdToSubportBuilder
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:
PortIdToSubportBuilder createTarget(int fooXyzzy, int barBaz) { return new PortIdToSubportBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PortIdToSubportBuilder, 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:
PortIdToSubportBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PortIdToSubportBuilder()
PortIdToSubportBuilder(PortIdToSubport base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PortIdToSubportBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
PortIdToSubport
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getPortId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTrunkPortId()
org.opendaylight.yangtools.yang.common.Uint32
getVlanId()
PortIdToSubportKey
key()
PortIdToSubportBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport>> augmentationType)
PortIdToSubportBuilder
setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
PortIdToSubportBuilder
setTrunkPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
PortIdToSubportBuilder
setVlanId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVlanId(Uint32)} instead.PortIdToSubportBuilder
setVlanId(org.opendaylight.yangtools.yang.common.Uint32 value)
PortIdToSubportBuilder
withKey(PortIdToSubportKey key)
-
-
-
Constructor Detail
-
PortIdToSubportBuilder
public PortIdToSubportBuilder()
-
PortIdToSubportBuilder
public PortIdToSubportBuilder(PortIdToSubport base)
-
-
Method Detail
-
key
public PortIdToSubportKey key()
-
getPortId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPortId()
-
getTrunkPortId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTrunkPortId()
-
getVlanId
public org.opendaylight.yangtools.yang.common.Uint32 getVlanId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public PortIdToSubportBuilder withKey(PortIdToSubportKey key)
-
setPortId
public PortIdToSubportBuilder setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setTrunkPortId
public PortIdToSubportBuilder setTrunkPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setVlanId
public PortIdToSubportBuilder setVlanId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setVlanId
@Deprecated(forRemoval=true) public PortIdToSubportBuilder setVlanId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVlanId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public PortIdToSubportBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport> augmentationValue)
-
removeAugmentation
public PortIdToSubportBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortIdToSubport>> augmentationType)
-
build
public PortIdToSubport build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PortIdToSubport>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PortIdToSubport,java.lang.IllegalArgumentException>
-
-