Class BasicProtectionBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.subobjects.subobject.type.basic.protection._case.BasicProtectionBuilder
Class that builds
BasicProtection
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:
BasicProtection createBasicProtection(int fooXyzzy, int barBaz) {
return new BasicProtectionBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of BasicProtection, 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 new builder initialized from specifiedProtectionSubobject
.Construct a builder initialized with state from specifiedBasicProtection
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtection> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtection>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull BasicProtection
build()
A newBasicProtection
instance.static @NonNull BasicProtection
empty()
Get empty instance of BasicProtection.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toProtectionSubobject.getProtectionSubobject()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtection>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toProtectionSubobject.getProtectionSubobject()
to the specified value.
-
Constructor Details
-
BasicProtectionBuilder
public BasicProtectionBuilder()Construct an empty builder. -
BasicProtectionBuilder
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
-
BasicProtectionBuilder
Construct a builder initialized with state from specifiedBasicProtection
.- Parameters:
base
- BasicProtection from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of BasicProtection.- Returns:
- An empty
BasicProtection
-
getProtectionSubobject
Return current value associated with the property corresponding toProtectionSubobject.getProtectionSubobject()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtection>> 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
Set the property corresponding toProtectionSubobject.getProtectionSubobject()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BasicProtectionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtection> 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 BasicProtectionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtection>> 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 newBasicProtection
instance.- Returns:
- A new
BasicProtection
instance.
-