Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools
Class PoolBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools.PoolBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Pool>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Pool,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PoolBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Pool>
Class that buildsPoolBuilder
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:
PoolBuilder createTarget(int fooXyzzy, int barBaz) { return new PoolBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PoolBuilder, 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:
PoolBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PoolBuilder()
PoolBuilder(BaseAttributes arg)
PoolBuilder(IdAttributes arg)
PoolBuilder(Pool base)
PoolBuilder(PoolAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PoolBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pool>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Pool> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.PoolBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Pool> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pool>>
E$$augmentation(Class<E$$> augmentationType)
Pool
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getHealthmonitorId()
String
getLbAlgorithm()
List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>
getListeners()
Members
getMembers()
String
getName()
String
getProjectId()
Class<? extends ProtocolBase>
getProtocol()
Long
getRevisionNumber()
SessionPersistence
getSessionPersistence()
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()
PoolKey
key()
PoolBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pool>> augmentationType)
Remove an augmentation from this builder's product.PoolBuilder
setAdminStateUp(Boolean value)
PoolBuilder
setHealthmonitorId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
PoolBuilder
setLbAlgorithm(String value)
PoolBuilder
setListeners(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
PoolBuilder
setMembers(Members value)
PoolBuilder
setName(String value)
PoolBuilder
setProjectId(String value)
PoolBuilder
setProtocol(Class<? extends ProtocolBase> value)
PoolBuilder
setRevisionNumber(Long value)
PoolBuilder
setSessionPersistence(SessionPersistence value)
PoolBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
PoolBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
PoolBuilder
withKey(PoolKey key)
-
-
-
Constructor Detail
-
PoolBuilder
public PoolBuilder()
-
PoolBuilder
public PoolBuilder(BaseAttributes arg)
-
PoolBuilder
public PoolBuilder(IdAttributes arg)
-
PoolBuilder
public PoolBuilder(PoolAttributes arg)
-
PoolBuilder
public PoolBuilder(Pool 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.lbaasv2.rev150712.PoolAttributes
- 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 PoolKey key()
-
getHealthmonitorId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getHealthmonitorId()
-
getLbAlgorithm
public String getLbAlgorithm()
-
getListeners
public List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getListeners()
-
getMembers
public Members getMembers()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getProtocol
public Class<? extends ProtocolBase> getProtocol()
-
getRevisionNumber
public Long getRevisionNumber()
-
getSessionPersistence
public SessionPersistence getSessionPersistence()
-
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<Pool>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PoolBuilder withKey(PoolKey key)
-
setHealthmonitorId
public PoolBuilder setHealthmonitorId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setLbAlgorithm
public PoolBuilder setLbAlgorithm(String value)
-
setListeners
public PoolBuilder setListeners(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
-
setMembers
public PoolBuilder setMembers(Members value)
-
setName
public PoolBuilder setName(String value)
-
setProjectId
public PoolBuilder setProjectId(String value)
-
setProtocol
public PoolBuilder setProtocol(Class<? extends ProtocolBase> value)
-
setRevisionNumber
public PoolBuilder setRevisionNumber(Long value)
-
setSessionPersistence
public PoolBuilder setSessionPersistence(SessionPersistence value)
-
setTenantId
public PoolBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public PoolBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setAdminStateUp
public PoolBuilder setAdminStateUp(Boolean value)
-
addAugmentation
public PoolBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Pool> 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 PoolBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pool>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Pool> 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 PoolBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pool>> 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 Pool build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Pool>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Pool,IllegalArgumentException>
-
-