Class NodeErrorNotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotificationBuilder
-
@Generated("mdsal-binding-generator") public class NodeErrorNotificationBuilder extends Object
Class that buildsNodeErrorNotification
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:
NodeErrorNotification createNodeErrorNotification(int fooXyzzy, int barBaz) { return new NodeErrorNotificationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NodeErrorNotification, 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:
NodeErrorNotification
- 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 NodeErrorNotificationBuilder()
Construct an empty builder.NodeErrorNotificationBuilder(ErrorMessage arg)
Construct a new builder initialized from specifiedErrorMessage
.NodeErrorNotificationBuilder(BaseNodeErrorNotification arg)
Construct a new builder initialized from specifiedBaseNodeErrorNotification
.NodeErrorNotificationBuilder(NodeErrorNotification base)
Construct a builder initialized with state from specifiedNodeErrorNotification
.NodeErrorNotificationBuilder(NodeErrorReference arg)
Construct a new builder initialized from specifiedNodeErrorReference
.NodeErrorNotificationBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.NodeErrorNotificationBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NodeErrorNotificationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NodeErrorNotification> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeErrorNotification>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NodeErrorNotification
build()
A newNodeErrorNotification
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getCode()
Return current value associated with the property corresponding toErrorMessage.getCode()
.String
getData()
Return current value associated with the property corresponding toErrorMessage.getData()
.NodeRef
getNode()
Return current value associated with the property corresponding toBaseNodeErrorNotification.getNode()
.ObjectReference
getObjectReference()
Return current value associated with the property corresponding toNodeErrorReference.getObjectReference()
.TransactionId
getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTransactionUri()
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.ErrorType
getType()
Return current value associated with the property corresponding toErrorMessage.getType()
.NodeErrorNotificationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeErrorNotification>> augmentationType)
Remove an augmentation from this builder's product.NodeErrorNotificationBuilder
setCode(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toErrorMessage.getCode()
to the specified value.NodeErrorNotificationBuilder
setData(String value)
Set the property corresponding toErrorMessage.getData()
to the specified value.NodeErrorNotificationBuilder
setNode(NodeRef value)
Set the property corresponding toBaseNodeErrorNotification.getNode()
to the specified value.NodeErrorNotificationBuilder
setObjectReference(ObjectReference value)
Set the property corresponding toNodeErrorReference.getObjectReference()
to the specified value.NodeErrorNotificationBuilder
setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.NodeErrorNotificationBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.NodeErrorNotificationBuilder
setType(ErrorType value)
Set the property corresponding toErrorMessage.getType()
to the specified value.
-
-
-
Constructor Detail
-
NodeErrorNotificationBuilder
public NodeErrorNotificationBuilder()
Construct an empty builder.
-
NodeErrorNotificationBuilder
public NodeErrorNotificationBuilder(ErrorMessage arg)
Construct a new builder initialized from specifiedErrorMessage
.- Parameters:
arg
- ErrorMessage from which the builder should be initialized
-
NodeErrorNotificationBuilder
public NodeErrorNotificationBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.- Parameters:
arg
- TransactionAware from which the builder should be initialized
-
NodeErrorNotificationBuilder
public NodeErrorNotificationBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.- Parameters:
arg
- TransactionMetadata from which the builder should be initialized
-
NodeErrorNotificationBuilder
public NodeErrorNotificationBuilder(NodeErrorReference arg)
Construct a new builder initialized from specifiedNodeErrorReference
.- Parameters:
arg
- NodeErrorReference from which the builder should be initialized
-
NodeErrorNotificationBuilder
public NodeErrorNotificationBuilder(BaseNodeErrorNotification arg)
Construct a new builder initialized from specifiedBaseNodeErrorNotification
.- Parameters:
arg
- BaseNodeErrorNotification from which the builder should be initialized
-
NodeErrorNotificationBuilder
public NodeErrorNotificationBuilder(NodeErrorNotification base)
Construct a builder initialized with state from specifiedNodeErrorNotification
.- Parameters:
base
- NodeErrorNotification from which the builder should be initialized
-
-
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:- 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()
Return current value associated with the property corresponding toErrorMessage.getCode()
.- Returns:
- current value
-
getData
public String getData()
Return current value associated with the property corresponding toErrorMessage.getData()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toBaseNodeErrorNotification.getNode()
.- Returns:
- current value
-
getObjectReference
public ObjectReference getObjectReference()
Return current value associated with the property corresponding toNodeErrorReference.getObjectReference()
.- Returns:
- current value
-
getTransactionId
public TransactionId getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.- Returns:
- current value
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.- Returns:
- current value
-
getType
public ErrorType getType()
Return current value associated with the property corresponding toErrorMessage.getType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeErrorNotification>> 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
-
setCode
public NodeErrorNotificationBuilder setCode(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toErrorMessage.getCode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setData
public NodeErrorNotificationBuilder setData(String value)
Set the property corresponding toErrorMessage.getData()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public NodeErrorNotificationBuilder setNode(NodeRef value)
Set the property corresponding toBaseNodeErrorNotification.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setObjectReference
public NodeErrorNotificationBuilder setObjectReference(ObjectReference value)
Set the property corresponding toNodeErrorReference.getObjectReference()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionId
public NodeErrorNotificationBuilder setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionUri
public NodeErrorNotificationBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
public NodeErrorNotificationBuilder setType(ErrorType value)
Set the property corresponding toErrorMessage.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NodeErrorNotificationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NodeErrorNotification> 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 NodeErrorNotificationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeErrorNotification>> 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 NodeErrorNotification build()
A newNodeErrorNotification
instance.- Returns:
- A new
NodeErrorNotification
instance.
-
-