Class FloatingipBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.floatingips.attributes.floatingips.FloatingipBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Floatingip>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Floatingip,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FloatingipBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Floatingip>
Class that buildsFloatingipBuilder
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:
FloatingipBuilder createTarget(int fooXyzzy, int barBaz) { return new FloatingipBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FloatingipBuilder, 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:
FloatingipBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FloatingipBuilder()
FloatingipBuilder(IdAttributes arg)
FloatingipBuilder(Floatingip base)
FloatingipBuilder(L3FloatingipAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatingipBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Floatingip> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingip>>
E$$augmentation(Class<E$$> augmentationType)
Floatingip
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.inet.types.rev130715.IpAddress
getFixedIpAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getFloatingIpAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getFloatingNetworkId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getPortId()
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
getTenantId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
FloatingipKey
key()
FloatingipBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingip>> augmentationType)
Remove an augmentation from this builder's product.FloatingipBuilder
setFixedIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
FloatingipBuilder
setFloatingIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
FloatingipBuilder
setFloatingNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FloatingipBuilder
setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FloatingipBuilder
setProjectId(String value)
FloatingipBuilder
setRevisionNumber(Long value)
FloatingipBuilder
setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FloatingipBuilder
setStatus(String value)
FloatingipBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FloatingipBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FloatingipBuilder
withKey(FloatingipKey key)
-
-
-
Constructor Detail
-
FloatingipBuilder
public FloatingipBuilder()
-
FloatingipBuilder
public FloatingipBuilder(IdAttributes arg)
-
FloatingipBuilder
public FloatingipBuilder(L3FloatingipAttributes arg)
-
FloatingipBuilder
public FloatingipBuilder(Floatingip 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:- L3FloatingipAttributes
- IdAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FloatingipKey key()
-
getFixedIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getFixedIpAddress()
-
getFloatingIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getFloatingIpAddress()
-
getFloatingNetworkId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getFloatingNetworkId()
-
getPortId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPortId()
-
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()
-
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<Floatingip>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FloatingipBuilder withKey(FloatingipKey key)
-
setFixedIpAddress
public FloatingipBuilder setFixedIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setFloatingIpAddress
public FloatingipBuilder setFloatingIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setFloatingNetworkId
public FloatingipBuilder setFloatingNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setPortId
public FloatingipBuilder setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setProjectId
public FloatingipBuilder setProjectId(String value)
-
setRevisionNumber
public FloatingipBuilder setRevisionNumber(Long value)
-
setRouterId
public FloatingipBuilder setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setStatus
public FloatingipBuilder setStatus(String value)
-
setTenantId
public FloatingipBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public FloatingipBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public FloatingipBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Floatingip> 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 FloatingipBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingip>> 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 Floatingip build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Floatingip>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Floatingip,IllegalArgumentException>
-
-