Class FailureCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.submit.instruction.output.result.FailureCaseBuilder
-
@Generated("mdsal-binding-generator") public class FailureCaseBuilder extends Object
Class that buildsFailureCase
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:
FailureCase createFailureCase(int fooXyzzy, int barBaz) { return new FailureCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FailureCase, 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:
FailureCase
- 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 FailureCaseBuilder()
Construct an empty builder.FailureCaseBuilder(FailureCase base)
Construct a builder initialized with state from specifiedFailureCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FailureCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FailureCase
build()
A newFailureCase
instance.Failure
getFailure()
Return current value associated with the property corresponding toFailureCase.getFailure()
.FailureCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType)
Remove an augmentation from this builder's product.FailureCaseBuilder
setFailure(Failure value)
Set the property corresponding toFailureCase.getFailure()
to the specified value.
-
-
-
Constructor Detail
-
FailureCaseBuilder
public FailureCaseBuilder()
Construct an empty builder.
-
FailureCaseBuilder
public FailureCaseBuilder(FailureCase base)
Construct a builder initialized with state from specifiedFailureCase
.- Parameters:
base
- FailureCase from which the builder should be initialized
-
-
Method Detail
-
getFailure
public Failure getFailure()
Return current value associated with the property corresponding toFailureCase.getFailure()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> 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
-
setFailure
public FailureCaseBuilder setFailure(Failure value)
Set the property corresponding toFailureCase.getFailure()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FailureCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase> 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 FailureCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> 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 FailureCase build()
A newFailureCase
instance.- Returns:
- A new
FailureCase
instance.
-
-