Class BundlePropertyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.common.grouping.BundlePropertyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BundleProperty>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BundleProperty,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BundlePropertyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BundleProperty>
Class that buildsBundlePropertyBuilder
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:
BundlePropertyBuilder createTarget(int fooXyzzy, int barBaz) { return new BundlePropertyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BundlePropertyBuilder, 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:
BundlePropertyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BundlePropertyBuilder()
BundlePropertyBuilder(BundleProperty base)
BundlePropertyBuilder(BundlePropertyGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BundlePropertyBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BundlePropertyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty>>
E$$augmentation(Class<E$$> augmentationType)
BundleProperty
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BundlePropertyEntry
getBundlePropertyEntry()
BundlePropertyType
getType()
BundlePropertyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty>> augmentationType)
Remove an augmentation from this builder's product.BundlePropertyBuilder
setBundlePropertyEntry(BundlePropertyEntry value)
BundlePropertyBuilder
setType(BundlePropertyType value)
-
-
-
Constructor Detail
-
BundlePropertyBuilder
public BundlePropertyBuilder()
-
BundlePropertyBuilder
public BundlePropertyBuilder(BundlePropertyGrouping arg)
-
BundlePropertyBuilder
public BundlePropertyBuilder(BundleProperty 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.openflowplugin.extension.onf.rev170124.BundlePropertyGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getBundlePropertyEntry
public BundlePropertyEntry getBundlePropertyEntry()
-
getType
public BundlePropertyType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty>> E$$ augmentation(Class<E$$> augmentationType)
-
setBundlePropertyEntry
public BundlePropertyBuilder setBundlePropertyEntry(BundlePropertyEntry value)
-
setType
public BundlePropertyBuilder setType(BundlePropertyType value)
-
addAugmentation
public BundlePropertyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty> 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 BundlePropertyBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty> 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 BundlePropertyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty>> 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 BundleProperty build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BundleProperty>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BundleProperty,IllegalArgumentException>
-
-