Class ExperimenterErrorNotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.node.error.service.rev140410.ExperimenterErrorNotificationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExperimenterErrorNotification>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterErrorNotification,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExperimenterErrorNotificationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ExperimenterErrorNotification>
Class that buildsExperimenterErrorNotification
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:
ExperimenterErrorNotification createExperimenterErrorNotification(int fooXyzzy, int barBaz) { return new ExperimenterErrorNotificationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExperimenterErrorNotification, 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:
ExperimenterErrorNotification
,Builder
-
-
Constructor Summary
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExperimenterErrorNotificationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterErrorNotification> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterErrorNotification>>
E$$augmentation(Class<E$$> augmentationType)
ExperimenterErrorNotification
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getCode()
String
getData()
NodeRef
getNode()
ObjectReference
getObjectReference()
TransactionId
getTransactionId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTransactionUri()
ErrorType
getType()
ExperimenterErrorNotificationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterErrorNotification>> augmentationType)
Remove an augmentation from this builder's product.ExperimenterErrorNotificationBuilder
setCode(org.opendaylight.yangtools.yang.common.Uint16 value)
ExperimenterErrorNotificationBuilder
setData(String value)
ExperimenterErrorNotificationBuilder
setNode(NodeRef value)
ExperimenterErrorNotificationBuilder
setObjectReference(ObjectReference value)
ExperimenterErrorNotificationBuilder
setTransactionId(TransactionId value)
ExperimenterErrorNotificationBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
ExperimenterErrorNotificationBuilder
setType(ErrorType value)
-
-
-
Constructor Detail
-
ExperimenterErrorNotificationBuilder
public ExperimenterErrorNotificationBuilder()
-
ExperimenterErrorNotificationBuilder
public ExperimenterErrorNotificationBuilder(ErrorMessage arg)
-
ExperimenterErrorNotificationBuilder
public ExperimenterErrorNotificationBuilder(TransactionAware arg)
-
ExperimenterErrorNotificationBuilder
public ExperimenterErrorNotificationBuilder(TransactionMetadata arg)
-
ExperimenterErrorNotificationBuilder
public ExperimenterErrorNotificationBuilder(BaseNodeErrorNotification arg)
-
ExperimenterErrorNotificationBuilder
public ExperimenterErrorNotificationBuilder(NodeErrorReference arg)
-
ExperimenterErrorNotificationBuilder
public ExperimenterErrorNotificationBuilder(ExperimenterErrorNotification base)
-
-
Method Detail
-
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:- TransactionAware
- TransactionMetadata
- ErrorMessage
- NodeErrorReference
- BaseNodeErrorNotification
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getCode
public org.opendaylight.yangtools.yang.common.Uint16 getCode()
-
getData
public String getData()
-
getNode
public NodeRef getNode()
-
getObjectReference
public ObjectReference getObjectReference()
-
getTransactionId
public TransactionId getTransactionId()
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
-
getType
public ErrorType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterErrorNotification>> E$$ augmentation(Class<E$$> augmentationType)
-
setCode
public ExperimenterErrorNotificationBuilder setCode(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setData
public ExperimenterErrorNotificationBuilder setData(String value)
-
setNode
public ExperimenterErrorNotificationBuilder setNode(NodeRef value)
-
setObjectReference
public ExperimenterErrorNotificationBuilder setObjectReference(ObjectReference value)
-
setTransactionId
public ExperimenterErrorNotificationBuilder setTransactionId(TransactionId value)
-
setTransactionUri
public ExperimenterErrorNotificationBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
setType
public ExperimenterErrorNotificationBuilder setType(ErrorType value)
-
addAugmentation
public ExperimenterErrorNotificationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterErrorNotification> 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 ExperimenterErrorNotificationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterErrorNotification>> 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 ExperimenterErrorNotification build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExperimenterErrorNotification>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterErrorNotification,IllegalArgumentException>
-
-