Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.authorization.events.top.events

Class EventBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.authorization.events.top.events.EventBuilder

All Implemented Interfaces:

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

@Generated("mdsal-binding-generator")
public class EventBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Event>

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

   
     Event createEvent(int fooXyzzy, int barBaz) {
         return new EventBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

Event, Builder

Constructor Summary

Constructors

Constructor	Description
EventBuilder()
EventBuilder(Event base)

Method Summary

Modifier and Type	Method	Description
EventBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Event> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Event>> E$$	augmentation(Class<E$$> augmentationType)
Event	build()
Config	getConfig()
Class<? extends AAAAUTHORIZATIONEVENTTYPE>	getEventType()
State	getState()
EventKey	key()
EventBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Event>> augmentationType)	Remove an augmentation from this builder's product.
EventBuilder	setConfig(Config value)
EventBuilder	setEventType(Class<? extends AAAAUTHORIZATIONEVENTTYPE> value)
EventBuilder	setState(State value)
EventBuilder	withKey(EventKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBuilder

public EventBuilder()

EventBuilder

public EventBuilder(Event base)

Method Detail

key

public EventKey key()

getConfig

public Config getConfig()

getEventType

public Class<? extends AAAAUTHORIZATIONEVENTTYPE> getEventType()

getState

public State getState()

augmentation

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

withKey

public EventBuilder withKey(EventKey key)

setConfig

public EventBuilder setConfig(Config value)

setEventType

public EventBuilder setEventType(Class<? extends AAAAUTHORIZATIONEVENTTYPE> value)

setState

public EventBuilder setState(State value)

addAugmentation

public EventBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Event> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

public EventBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Event>> 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 Event build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<Event>

Specified by:

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