Class VpnserviceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.vpnservices.attributes.vpn.services.VpnserviceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Vpnservice>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Vpnservice,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VpnserviceBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Vpnservice>
Class that buildsVpnserviceBuilder
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:
VpnserviceBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnserviceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnserviceBuilder, 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:
VpnserviceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnserviceBuilder()
VpnserviceBuilder(AdminAttributes arg)
VpnserviceBuilder(BaseAttributes arg)
VpnserviceBuilder(IdAttributes arg)
VpnserviceBuilder(VpnserviceAttributes arg)
VpnserviceBuilder(Vpnservice base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnserviceBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.VpnserviceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice>>
E$$augmentation(Class<E$$> augmentationType)
Vpnservice
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getName()
String
getProjectId()
Long
getRevisionNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getRouterId()
String
getStatus()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getSubnetId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
Boolean
isAdminStateUp()
VpnserviceKey
key()
VpnserviceBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice>> augmentationType)
Remove an augmentation from this builder's product.VpnserviceBuilder
setAdminStateUp(Boolean value)
VpnserviceBuilder
setName(String value)
VpnserviceBuilder
setProjectId(String value)
VpnserviceBuilder
setRevisionNumber(Long value)
VpnserviceBuilder
setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
VpnserviceBuilder
setStatus(String value)
VpnserviceBuilder
setSubnetId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
VpnserviceBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
VpnserviceBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
VpnserviceBuilder
withKey(VpnserviceKey key)
-
-
-
Constructor Detail
-
VpnserviceBuilder
public VpnserviceBuilder()
-
VpnserviceBuilder
public VpnserviceBuilder(BaseAttributes arg)
-
VpnserviceBuilder
public VpnserviceBuilder(IdAttributes arg)
-
VpnserviceBuilder
public VpnserviceBuilder(AdminAttributes arg)
-
VpnserviceBuilder
public VpnserviceBuilder(VpnserviceAttributes arg)
-
VpnserviceBuilder
public VpnserviceBuilder(Vpnservice base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.AdminAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.VpnserviceAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public VpnserviceKey key()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getRouterId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterId()
-
getStatus
public String getStatus()
-
getSubnetId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSubnetId()
-
getTenantId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
-
getUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()
-
isAdminStateUp
public Boolean isAdminStateUp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public VpnserviceBuilder withKey(VpnserviceKey key)
-
setName
public VpnserviceBuilder setName(String value)
-
setProjectId
public VpnserviceBuilder setProjectId(String value)
-
setRevisionNumber
public VpnserviceBuilder setRevisionNumber(Long value)
-
setRouterId
public VpnserviceBuilder setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setStatus
public VpnserviceBuilder setStatus(String value)
-
setSubnetId
public VpnserviceBuilder setSubnetId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setTenantId
public VpnserviceBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public VpnserviceBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setAdminStateUp
public VpnserviceBuilder setAdminStateUp(Boolean value)
-
addAugmentation
public VpnserviceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public VpnserviceBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice> 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 VpnserviceBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpnservice>> 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 Vpnservice build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Vpnservice>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Vpnservice,IllegalArgumentException>
-
-