Class DynamicControlProtectionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.subobjects.subobject.type.dynamic.control.protection._case.DynamicControlProtectionBuilder
-
@Generated("mdsal-binding-generator") public class DynamicControlProtectionBuilder extends Object
Class that buildsDynamicControlProtection
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:
DynamicControlProtection createDynamicControlProtection(int fooXyzzy, int barBaz) { return new DynamicControlProtectionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DynamicControlProtection, 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:
DynamicControlProtection
- 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 DynamicControlProtectionBuilder()
Construct an empty builder.DynamicControlProtectionBuilder(ProtectionSubobject arg)
Construct a new builder initialized from specifiedProtectionSubobject
.DynamicControlProtectionBuilder(DynamicControlProtection base)
Construct a builder initialized with state from specifiedDynamicControlProtection
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DynamicControlProtectionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtection> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtection>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DynamicControlProtection
build()
A newDynamicControlProtection
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ProtectionSubobject
getProtectionSubobject()
Return current value associated with the property corresponding toProtectionSubobject.getProtectionSubobject()
.DynamicControlProtectionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtection>> augmentationType)
Remove an augmentation from this builder's product.DynamicControlProtectionBuilder
setProtectionSubobject(ProtectionSubobject value)
Set the property corresponding toProtectionSubobject.getProtectionSubobject()
to the specified value.
-
-
-
Constructor Detail
-
DynamicControlProtectionBuilder
public DynamicControlProtectionBuilder()
Construct an empty builder.
-
DynamicControlProtectionBuilder
public DynamicControlProtectionBuilder(ProtectionSubobject arg)
Construct a new builder initialized from specifiedProtectionSubobject
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ProtectionSubobject from which the builder should be initialized
-
DynamicControlProtectionBuilder
public DynamicControlProtectionBuilder(DynamicControlProtection base)
Construct a builder initialized with state from specifiedDynamicControlProtection
.- Parameters:
base
- DynamicControlProtection 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
-
getProtectionSubobject
public ProtectionSubobject getProtectionSubobject()
Return current value associated with the property corresponding toProtectionSubobject.getProtectionSubobject()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtection>> 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
-
setProtectionSubobject
public DynamicControlProtectionBuilder setProtectionSubobject(ProtectionSubobject value)
Set the property corresponding toProtectionSubobject.getProtectionSubobject()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DynamicControlProtectionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtection> 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 DynamicControlProtectionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DynamicControlProtection>> 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 DynamicControlProtection build()
A newDynamicControlProtection
instance.- Returns:
- A new
DynamicControlProtection
instance.
-
-