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