org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcntf.message.pcntf.message.notifications

Class NotificationsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcntf.message.pcntf.message.notifications.NotificationsBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Notifications>, org.opendaylight.yangtools.concepts.CheckedBuilder<Notifications,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class NotificationsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Notifications>

Class that builds NotificationsBuilder 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:

   
     NotificationsBuilder createTarget(int fooXyzzy, int barBaz) {
         return new NotificationsBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of NotificationsBuilder, 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:

NotificationsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NotificationsBuilder()
NotificationsBuilder(NotificationObject arg)
NotificationsBuilder(Notifications base)

Method Summary

Modifier and Type	Method and Description
NotificationsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notifications>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Notifications> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notifications>> E$$	augmentation(Class<E$$> augmentationType)
Notifications	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
CNotification	getCNotification()
NotificationsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notifications>> augmentationType)
NotificationsBuilder	setCNotification(CNotification value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationsBuilder

public NotificationsBuilder()

NotificationsBuilder

public NotificationsBuilder(NotificationObject arg)

NotificationsBuilder

public NotificationsBuilder(Notifications 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:

• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.NotificationObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getCNotification

public CNotification getCNotification()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notifications>> E$$ augmentation(Class<E$$> augmentationType)

setCNotification

public NotificationsBuilder setCNotification(CNotification value)

addAugmentation

public NotificationsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notifications>> augmentationType,
                                            org.opendaylight.yangtools.yang.binding.Augmentation<Notifications> augmentationValue)

removeAugmentation

public NotificationsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notifications>> augmentationType)

build

public Notifications build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Notifications,IllegalArgumentException>