Class NotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.down.data.notification.NotificationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Notification>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Notification,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NotificationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Notification>
Class that buildsNotification
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:
Notification createNotification(int fooXyzzy, int barBaz) { return new NotificationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Notification, 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:
Notification
,Builder
-
-
Constructor Summary
Constructors Constructor Description NotificationBuilder()
NotificationBuilder(NotifyMessage arg)
NotificationBuilder(Notification base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NotificationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Notification> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notification>>
E$$augmentation(Class<E$$> augmentationType)
Notification
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.byte[]
getData()
org.opendaylight.yangtools.yang.common.Uint8
getErrorCode()
org.opendaylight.yangtools.yang.common.Uint8
getErrorSubcode()
NotificationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notification>> augmentationType)
Remove an augmentation from this builder's product.NotificationBuilder
setData(byte[] value)
NotificationBuilder
setErrorCode(org.opendaylight.yangtools.yang.common.Uint8 value)
NotificationBuilder
setErrorSubcode(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
NotificationBuilder
public NotificationBuilder()
-
NotificationBuilder
public NotificationBuilder(NotifyMessage arg)
-
NotificationBuilder
public NotificationBuilder(Notification 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:- NotifyMessage
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getData
public byte[] getData()
-
getErrorCode
public org.opendaylight.yangtools.yang.common.Uint8 getErrorCode()
-
getErrorSubcode
public org.opendaylight.yangtools.yang.common.Uint8 getErrorSubcode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notification>> E$$ augmentation(Class<E$$> augmentationType)
-
setData
public NotificationBuilder setData(byte[] value)
-
setErrorCode
public NotificationBuilder setErrorCode(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setErrorSubcode
public NotificationBuilder setErrorSubcode(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public NotificationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Notification> 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 NotificationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notification>> 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 Notification build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Notification>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Notification,IllegalArgumentException>
-
-