Class FailureCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.submit.instruction.output.result.FailureCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FailureCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FailureCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FailureCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FailureCase>
Class that buildsFailureCaseBuilder
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:
FailureCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new FailureCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FailureCaseBuilder, 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 oportunities, 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:
FailureCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FailureCaseBuilder()
FailureCaseBuilder(FailureCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FailureCaseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>>
E$$augmentation(Class<E$$> augmentationType)
FailureCase
build()
Failure
getFailure()
FailureCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType)
FailureCaseBuilder
setFailure(Failure value)
-
-
-
Constructor Detail
-
FailureCaseBuilder
public FailureCaseBuilder()
-
FailureCaseBuilder
public FailureCaseBuilder(FailureCase base)
-
-
Method Detail
-
getFailure
public Failure getFailure()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setFailure
public FailureCaseBuilder setFailure(Failure value)
-
addAugmentation
public FailureCaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase> augmentationValue)
-
removeAugmentation
public FailureCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType)
-
build
public FailureCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FailureCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FailureCase,IllegalArgumentException>
-
-