Class IkepolicyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.ikepolicies.attributes.ike.policies.IkepolicyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ikepolicy>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ikepolicy,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IkepolicyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ikepolicy>
Class that buildsIkepolicyBuilder
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:
IkepolicyBuilder createTarget(int fooXyzzy, int barBaz) { return new IkepolicyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IkepolicyBuilder, 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:
IkepolicyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IkepolicyBuilder()
IkepolicyBuilder(BaseAttributes arg)
IkepolicyBuilder(IdAttributes arg)
IkepolicyBuilder(Ikepolicy base)
IkepolicyBuilder(IkepolicyAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IkepolicyBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ikepolicy>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ikepolicy> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ikepolicy>>
E$$augmentation(Class<E$$> augmentationType)
Ikepolicy
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getAuthAlgorithm()
String
getEncryptionAlgorithm()
String
getIkeVersion()
Lifetime
getLifetime()
String
getName()
String
getPfs()
String
getPhaseNegotiationMode()
String
getProjectId()
Long
getRevisionNumber()
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()
IkepolicyKey
key()
IkepolicyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ikepolicy>> augmentationType)
IkepolicyBuilder
setAuthAlgorithm(String value)
IkepolicyBuilder
setEncryptionAlgorithm(String value)
IkepolicyBuilder
setIkeVersion(String value)
IkepolicyBuilder
setLifetime(Lifetime value)
IkepolicyBuilder
setName(String value)
IkepolicyBuilder
setPfs(String value)
IkepolicyBuilder
setPhaseNegotiationMode(String value)
IkepolicyBuilder
setProjectId(String value)
IkepolicyBuilder
setRevisionNumber(Long value)
IkepolicyBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
IkepolicyBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
IkepolicyBuilder
withKey(IkepolicyKey key)
-
-
-
Constructor Detail
-
IkepolicyBuilder
public IkepolicyBuilder()
-
IkepolicyBuilder
public IkepolicyBuilder(BaseAttributes arg)
-
IkepolicyBuilder
public IkepolicyBuilder(IdAttributes arg)
-
IkepolicyBuilder
public IkepolicyBuilder(IkepolicyAttributes arg)
-
IkepolicyBuilder
public IkepolicyBuilder(Ikepolicy 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.IkepolicyAttributes
- 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
-
key
public IkepolicyKey key()
-
getAuthAlgorithm
public String getAuthAlgorithm()
-
getEncryptionAlgorithm
public String getEncryptionAlgorithm()
-
getIkeVersion
public String getIkeVersion()
-
getLifetime
public Lifetime getLifetime()
-
getName
public String getName()
-
getPfs
public String getPfs()
-
getPhaseNegotiationMode
public String getPhaseNegotiationMode()
-
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()
-
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<Ikepolicy>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public IkepolicyBuilder withKey(IkepolicyKey key)
-
setAuthAlgorithm
public IkepolicyBuilder setAuthAlgorithm(String value)
-
setEncryptionAlgorithm
public IkepolicyBuilder setEncryptionAlgorithm(String value)
-
setIkeVersion
public IkepolicyBuilder setIkeVersion(String value)
-
setLifetime
public IkepolicyBuilder setLifetime(Lifetime value)
-
setName
public IkepolicyBuilder setName(String value)
-
setPfs
public IkepolicyBuilder setPfs(String value)
-
setPhaseNegotiationMode
public IkepolicyBuilder setPhaseNegotiationMode(String value)
-
setProjectId
public IkepolicyBuilder setProjectId(String value)
-
setRevisionNumber
public IkepolicyBuilder setRevisionNumber(Long value)
-
setTenantId
public IkepolicyBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public IkepolicyBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public IkepolicyBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ikepolicy>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ikepolicy> augmentationValue)
-
removeAugmentation
public IkepolicyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ikepolicy>> augmentationType)
-
build
public Ikepolicy build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ikepolicy>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ikepolicy,IllegalArgumentException>
-
-