Class BundlePropertyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.common.grouping.BundlePropertyBuilder
-
@Generated("mdsal-binding-generator") public class BundlePropertyBuilder extends Object
Class that buildsBundleProperty
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:
BundleProperty createBundleProperty(int fooXyzzy, int barBaz) { return new BundlePropertyBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BundleProperty, 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:
BundleProperty
- 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
-
-
Constructor Summary
Constructors Constructor Description BundlePropertyBuilder()
Construct an empty builder.BundlePropertyBuilder(BundleProperty base)
Construct a builder initialized with state from specifiedBundleProperty
.BundlePropertyBuilder(BundlePropertyGrouping arg)
Construct a new builder initialized from specifiedBundlePropertyGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
Return the specified augmentation, if it is present in this builder.@NonNull BundleProperty
build()
A newBundleProperty
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BundlePropertyEntry
getBundlePropertyEntry()
Return current value associated with the property corresponding toBundlePropertyGrouping.getBundlePropertyEntry()
.BundlePropertyType
getType()
Return current value associated with the property corresponding toBundlePropertyGrouping.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)
Set the property corresponding toBundlePropertyGrouping.getBundlePropertyEntry()
to the specified value.BundlePropertyBuilder
setType(BundlePropertyType value)
Set the property corresponding toBundlePropertyGrouping.getType()
to the specified value.
-
-
-
Constructor Detail
-
BundlePropertyBuilder
public BundlePropertyBuilder()
Construct an empty builder.
-
BundlePropertyBuilder
public BundlePropertyBuilder(BundlePropertyGrouping arg)
Construct a new builder initialized from specifiedBundlePropertyGrouping
.- Parameters:
arg
- BundlePropertyGrouping from which the builder should be initialized
-
BundlePropertyBuilder
public BundlePropertyBuilder(BundleProperty base)
Construct a builder initialized with state from specifiedBundleProperty
.- Parameters:
base
- BundleProperty from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBundlePropertyEntry
public BundlePropertyEntry getBundlePropertyEntry()
Return current value associated with the property corresponding toBundlePropertyGrouping.getBundlePropertyEntry()
.- Returns:
- current value
-
getType
public BundlePropertyType getType()
Return current value associated with the property corresponding toBundlePropertyGrouping.getType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleProperty>> 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
-
setBundlePropertyEntry
public BundlePropertyBuilder setBundlePropertyEntry(BundlePropertyEntry value)
Set the property corresponding toBundlePropertyGrouping.getBundlePropertyEntry()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
public BundlePropertyBuilder setType(BundlePropertyType value)
Set the property corresponding toBundlePropertyGrouping.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
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 @NonNull BundleProperty build()
A newBundleProperty
instance.- Returns:
- A new
BundleProperty
instance.
-
-