Class PeerDownNotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerDownNotificationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PeerDownNotification>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PeerDownNotification,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PeerDownNotificationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PeerDownNotification>
Class that buildsPeerDownNotificationBuilder
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:
PeerDownNotificationBuilder createTarget(int fooXyzzy, int barBaz) { return new PeerDownNotificationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerDownNotificationBuilder, 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:
PeerDownNotificationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerDownNotificationBuilder()
PeerDownNotificationBuilder(PeerDown arg)
PeerDownNotificationBuilder(PeerDownNotification base)
PeerDownNotificationBuilder(PeerHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PeerDownNotificationBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.PeerDownNotificationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification>>
E$$augmentation(Class<E$$> augmentationType)
PeerDownNotification
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Data
getData()
PeerHeader
getPeerHeader()
Boolean
isLocalSystemClosed()
PeerDownNotificationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification>> augmentationType)
Remove an augmentation from this builder's product.PeerDownNotificationBuilder
setData(Data value)
PeerDownNotificationBuilder
setLocalSystemClosed(Boolean value)
PeerDownNotificationBuilder
setPeerHeader(PeerHeader value)
-
-
-
Constructor Detail
-
PeerDownNotificationBuilder
public PeerDownNotificationBuilder()
-
PeerDownNotificationBuilder
public PeerDownNotificationBuilder(PeerHeader arg)
-
PeerDownNotificationBuilder
public PeerDownNotificationBuilder(PeerDown arg)
-
PeerDownNotificationBuilder
public PeerDownNotificationBuilder(PeerDownNotification 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.bmp.message.rev200120.PeerDown
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getData
public Data getData()
-
getPeerHeader
public PeerHeader getPeerHeader()
-
isLocalSystemClosed
public Boolean isLocalSystemClosed()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification>> E$$ augmentation(Class<E$$> augmentationType)
-
setData
public PeerDownNotificationBuilder setData(Data value)
-
setPeerHeader
public PeerDownNotificationBuilder setPeerHeader(PeerHeader value)
-
setLocalSystemClosed
public PeerDownNotificationBuilder setLocalSystemClosed(Boolean value)
-
addAugmentation
public PeerDownNotificationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public PeerDownNotificationBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public PeerDownNotificationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerDownNotification>> 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 PeerDownNotification build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PeerDownNotification>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PeerDownNotification,IllegalArgumentException>
-
-