Class FloatingipsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.floatingips.attributes.FloatingipsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Floatingips>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Floatingips,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FloatingipsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Floatingips>
Class that buildsFloatingipsBuilder
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:
FloatingipsBuilder createTarget(int fooXyzzy, int barBaz) { return new FloatingipsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FloatingipsBuilder, 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:
FloatingipsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FloatingipsBuilder()
FloatingipsBuilder(Floatingips base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FloatingipsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.FloatingipsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips>>
E$$augmentation(Class<E$$> augmentationType)
Floatingips
build()
Map<FloatingipKey,Floatingip>
getFloatingip()
FloatingipsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips>> augmentationType)
Remove an augmentation from this builder's product.FloatingipsBuilder
setFloatingip(List<Floatingip> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFloatingip(Map)
instead.FloatingipsBuilder
setFloatingip(Map<FloatingipKey,Floatingip> values)
-
-
-
Constructor Detail
-
FloatingipsBuilder
public FloatingipsBuilder()
-
FloatingipsBuilder
public FloatingipsBuilder(Floatingips base)
-
-
Method Detail
-
getFloatingip
public Map<FloatingipKey,Floatingip> getFloatingip()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips>> E$$ augmentation(Class<E$$> augmentationType)
-
setFloatingip
public FloatingipsBuilder setFloatingip(Map<FloatingipKey,Floatingip> values)
-
setFloatingip
@Deprecated(forRemoval=true) public FloatingipsBuilder setFloatingip(List<Floatingip> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFloatingip(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public FloatingipsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips> 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 FloatingipsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips> 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 FloatingipsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Floatingips>> 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 Floatingips build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Floatingips>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Floatingips,IllegalArgumentException>
-
-