Class BundlePropertyExperimenterBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.property.grouping.bundle.property.entry.BundlePropertyExperimenterBuilder
Class that builds
BundlePropertyExperimenter
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:
BundlePropertyExperimenter createBundlePropertyExperimenter(int fooXyzzy, int barBaz) {
return new BundlePropertyExperimenterBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of BundlePropertyExperimenter, 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 opportunities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedBundlePropertyExperimenter
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<BundlePropertyExperimenter> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BundlePropertyExperimenter>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull BundlePropertyExperimenter
build()
A newBundlePropertyExperimenter
instance.Return current value associated with the property corresponding toBundlePropertyExperimenter.getBundlePropertyExperimenterData()
.Return current value associated with the property corresponding toBundlePropertyExperimenter.getExperimenter()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toBundlePropertyExperimenter.getExpType()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundlePropertyExperimenter>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toBundlePropertyExperimenter.getBundlePropertyExperimenterData()
to the specified value.setExperimenter
(ExperimenterId value) Set the property corresponding toBundlePropertyExperimenter.getExperimenter()
to the specified value.setExpType
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toBundlePropertyExperimenter.getExpType()
to the specified value.
-
Constructor Details
-
BundlePropertyExperimenterBuilder
public BundlePropertyExperimenterBuilder()Construct an empty builder. -
BundlePropertyExperimenterBuilder
Construct a builder initialized with state from specifiedBundlePropertyExperimenter
.- Parameters:
base
- BundlePropertyExperimenter from which the builder should be initialized
-
-
Method Details
-
getBundlePropertyExperimenterData
Return current value associated with the property corresponding toBundlePropertyExperimenter.getBundlePropertyExperimenterData()
.- Returns:
- current value
-
getExpType
public org.opendaylight.yangtools.yang.common.Uint32 getExpType()Return current value associated with the property corresponding toBundlePropertyExperimenter.getExpType()
.- Returns:
- current value
-
getExperimenter
Return current value associated with the property corresponding toBundlePropertyExperimenter.getExperimenter()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BundlePropertyExperimenter>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setBundlePropertyExperimenterData
public BundlePropertyExperimenterBuilder setBundlePropertyExperimenterData(BundlePropertyExperimenterData value) Set the property corresponding toBundlePropertyExperimenter.getBundlePropertyExperimenterData()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExpType
public BundlePropertyExperimenterBuilder setExpType(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toBundlePropertyExperimenter.getExpType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExperimenter
Set the property corresponding toBundlePropertyExperimenter.getExperimenter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BundlePropertyExperimenterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BundlePropertyExperimenter> 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 BundlePropertyExperimenterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundlePropertyExperimenter>> 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
A newBundlePropertyExperimenter
instance.- Returns:
- A new
BundlePropertyExperimenter
instance.
-