Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202
Class TopicNotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicNotificationBuilder
-
- All Implemented Interfaces:
Builder<TopicNotification>
,CheckedBuilder<TopicNotification,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class TopicNotificationBuilder extends Object implements Builder<TopicNotification>
Class that buildsTopicNotificationBuilder
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:
TopicNotificationBuilder createTarget(int fooXyzzy, int barBaz) { return new TopicNotificationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TopicNotificationBuilder, 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:
TopicNotificationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TopicNotificationBuilder()
TopicNotificationBuilder(TopicNotification base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TopicNotificationBuilder
addAugmentation(Augmentation<TopicNotification> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<TopicNotification>>
E$$augmentation(Class<E$$> augmentationType)
TopicNotification
build()
String
getNodeId()
Payload
getPayload()
TopicId
getTopicId()
TopicNotificationBuilder
removeAugmentation(Class<? extends Augmentation<TopicNotification>> augmentationType)
Remove an augmentation from this builder's product.TopicNotificationBuilder
setNodeId(String value)
TopicNotificationBuilder
setPayload(Payload value)
TopicNotificationBuilder
setTopicId(TopicId value)
-
-
-
Constructor Detail
-
TopicNotificationBuilder
public TopicNotificationBuilder()
-
TopicNotificationBuilder
public TopicNotificationBuilder(TopicNotification base)
-
-
Method Detail
-
getNodeId
public String getNodeId()
-
getPayload
public Payload getPayload()
-
getTopicId
public TopicId getTopicId()
-
augmentation
public <E$$ extends Augmentation<TopicNotification>> E$$ augmentation(Class<E$$> augmentationType)
-
setNodeId
public TopicNotificationBuilder setNodeId(String value)
-
setPayload
public TopicNotificationBuilder setPayload(Payload value)
-
setTopicId
public TopicNotificationBuilder setTopicId(TopicId value)
-
addAugmentation
public TopicNotificationBuilder addAugmentation(Augmentation<TopicNotification> 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 TopicNotificationBuilder removeAugmentation(Class<? extends Augmentation<TopicNotification>> 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 TopicNotification build()
- Specified by:
build
in interfaceBuilder<TopicNotification>
- Specified by:
build
in interfaceCheckedBuilder<TopicNotification,IllegalArgumentException>
-
-