Class IpsecpolicyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.ipsecpolicies.attributes.ipsec.policies.IpsecpolicyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipsecpolicy>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipsecpolicy,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpsecpolicyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipsecpolicy>
Class that buildsIpsecpolicyBuilder
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:
IpsecpolicyBuilder createTarget(int fooXyzzy, int barBaz) { return new IpsecpolicyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpsecpolicyBuilder, 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:
IpsecpolicyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpsecpolicyBuilder()
IpsecpolicyBuilder(BaseAttributes arg)
IpsecpolicyBuilder(IdAttributes arg)
IpsecpolicyBuilder(Ipsecpolicy base)
IpsecpolicyBuilder(IpsecpolicyAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpsecpolicyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipsecpolicy> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipsecpolicy>>
E$$augmentation(Class<E$$> augmentationType)
Ipsecpolicy
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getAuthAlgorithm()
String
getEncapsulationMode()
String
getEncryptionAlgorithm()
Lifetime
getLifetime()
String
getName()
String
getPfs()
String
getProjectId()
Long
getRevisionNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
String
getTransformProtocol()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
IpsecpolicyKey
key()
IpsecpolicyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipsecpolicy>> augmentationType)
Remove an augmentation from this builder's product.IpsecpolicyBuilder
setAuthAlgorithm(String value)
IpsecpolicyBuilder
setEncapsulationMode(String value)
IpsecpolicyBuilder
setEncryptionAlgorithm(String value)
IpsecpolicyBuilder
setLifetime(Lifetime value)
IpsecpolicyBuilder
setName(String value)
IpsecpolicyBuilder
setPfs(String value)
IpsecpolicyBuilder
setProjectId(String value)
IpsecpolicyBuilder
setRevisionNumber(Long value)
IpsecpolicyBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
IpsecpolicyBuilder
setTransformProtocol(String value)
IpsecpolicyBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
IpsecpolicyBuilder
withKey(IpsecpolicyKey key)
-
-
-
Constructor Detail
-
IpsecpolicyBuilder
public IpsecpolicyBuilder()
-
IpsecpolicyBuilder
public IpsecpolicyBuilder(BaseAttributes arg)
-
IpsecpolicyBuilder
public IpsecpolicyBuilder(IdAttributes arg)
-
IpsecpolicyBuilder
public IpsecpolicyBuilder(IpsecpolicyAttributes arg)
-
IpsecpolicyBuilder
public IpsecpolicyBuilder(Ipsecpolicy 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.vpnaas.rev150712.IpsecpolicyAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
- 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 or has property with incompatible value
-
key
public IpsecpolicyKey key()
-
getAuthAlgorithm
public String getAuthAlgorithm()
-
getEncapsulationMode
public String getEncapsulationMode()
-
getEncryptionAlgorithm
public String getEncryptionAlgorithm()
-
getLifetime
public Lifetime getLifetime()
-
getName
public String getName()
-
getPfs
public String getPfs()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getTenantId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
-
getTransformProtocol
public String getTransformProtocol()
-
getUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipsecpolicy>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public IpsecpolicyBuilder withKey(IpsecpolicyKey key)
-
setAuthAlgorithm
public IpsecpolicyBuilder setAuthAlgorithm(String value)
-
setEncapsulationMode
public IpsecpolicyBuilder setEncapsulationMode(String value)
-
setEncryptionAlgorithm
public IpsecpolicyBuilder setEncryptionAlgorithm(String value)
-
setLifetime
public IpsecpolicyBuilder setLifetime(Lifetime value)
-
setName
public IpsecpolicyBuilder setName(String value)
-
setPfs
public IpsecpolicyBuilder setPfs(String value)
-
setProjectId
public IpsecpolicyBuilder setProjectId(String value)
-
setRevisionNumber
public IpsecpolicyBuilder setRevisionNumber(Long value)
-
setTenantId
public IpsecpolicyBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setTransformProtocol
public IpsecpolicyBuilder setTransformProtocol(String value)
-
setUuid
public IpsecpolicyBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public IpsecpolicyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipsecpolicy> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public IpsecpolicyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipsecpolicy>> 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 Ipsecpolicy build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipsecpolicy>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipsecpolicy,IllegalArgumentException>
-
-