Class ErrorMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.consistency.checker.inconsistency.action.ErrorMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ErrorMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ErrorMessage,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ErrorMessageBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<ErrorMessage>
Class that buildsErrorMessageBuilder
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:
ErrorMessageBuilder createTarget(int fooXyzzy, int barBaz) { return new ErrorMessageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ErrorMessageBuilder, 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:
ErrorMessageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ErrorMessageBuilder()
ErrorMessageBuilder(ErrorMessage base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ErrorMessageBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
ErrorMessage
build()
java.lang.Boolean
isGenerateErrorMessageOnly()
ErrorMessageBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>> augmentationType)
ErrorMessageBuilder
setGenerateErrorMessageOnly(java.lang.Boolean value)
-
-
-
Constructor Detail
-
ErrorMessageBuilder
public ErrorMessageBuilder()
-
ErrorMessageBuilder
public ErrorMessageBuilder(ErrorMessage base)
-
-
Method Detail
-
isGenerateErrorMessageOnly
public java.lang.Boolean isGenerateErrorMessageOnly()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setGenerateErrorMessageOnly
public ErrorMessageBuilder setGenerateErrorMessageOnly(java.lang.Boolean value)
-
addAugmentation
public ErrorMessageBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage> augmentationValue)
-
removeAugmentation
public ErrorMessageBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>> augmentationType)
-
build
public ErrorMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ErrorMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ErrorMessage,java.lang.IllegalArgumentException>
-
-