Class NotifyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.NotifyBuilder
-
@Generated("mdsal-binding-generator") public class NotifyBuilder extends Object
Class that buildsNotify
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:
Notify createNotify(int fooXyzzy, int barBaz) { return new NotifyBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Notify, 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:
Notify
- 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 NotifyBuilder()
Construct an empty builder.NotifyBuilder(Notify base)
Construct a builder initialized with state from specifiedNotify
.NotifyBuilder(NotifyMessage arg)
Construct a new builder initialized from specifiedNotifyMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NotifyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Notify> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Notify
build()
A newNotify
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.byte[]
getData()
Return current value associated with the property corresponding toNotifyMessage.getData()
.org.opendaylight.yangtools.yang.common.Uint8
getErrorCode()
Return current value associated with the property corresponding toNotifyMessage.getErrorCode()
.org.opendaylight.yangtools.yang.common.Uint8
getErrorSubcode()
Return current value associated with the property corresponding toNotifyMessage.getErrorSubcode()
.NotifyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>> augmentationType)
Remove an augmentation from this builder's product.NotifyBuilder
setData(byte[] value)
Set the property corresponding toNotifyMessage.getData()
to the specified value.NotifyBuilder
setErrorCode(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toNotifyMessage.getErrorCode()
to the specified value.NotifyBuilder
setErrorSubcode(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toNotifyMessage.getErrorSubcode()
to the specified value.
-
-
-
Constructor Detail
-
NotifyBuilder
public NotifyBuilder()
Construct an empty builder.
-
NotifyBuilder
public NotifyBuilder(NotifyMessage arg)
Construct a new builder initialized from specifiedNotifyMessage
.- Parameters:
arg
- NotifyMessage 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
-
getData
public byte[] getData()
Return current value associated with the property corresponding toNotifyMessage.getData()
.- Returns:
- current value
-
getErrorCode
public org.opendaylight.yangtools.yang.common.Uint8 getErrorCode()
Return current value associated with the property corresponding toNotifyMessage.getErrorCode()
.- Returns:
- current value
-
getErrorSubcode
public org.opendaylight.yangtools.yang.common.Uint8 getErrorSubcode()
Return current value associated with the property corresponding toNotifyMessage.getErrorSubcode()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>> 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
-
setData
public NotifyBuilder setData(byte[] value)
Set the property corresponding toNotifyMessage.getData()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setErrorCode
public NotifyBuilder setErrorCode(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toNotifyMessage.getErrorCode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setErrorSubcode
public NotifyBuilder setErrorSubcode(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toNotifyMessage.getErrorSubcode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NotifyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Notify> 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 NotifyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>> 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
-
-