Class CNotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.notification.object.CNotificationBuilder
-
@Generated("mdsal-binding-generator") public class CNotificationBuilder extends Object
Class that buildsCNotification
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:
CNotification createCNotification(int fooXyzzy, int barBaz) { return new CNotificationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CNotification, 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:
CNotification
- 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
-
-
Constructor Summary
Constructors Constructor Description CNotificationBuilder()
Construct an empty builder.CNotificationBuilder(CNotification base)
Construct a builder initialized with state from specifiedCNotification
.CNotificationBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.CNotificationBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CNotificationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CNotification> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull CNotification
build()
A newCNotification
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Tlvs
getTlvs()
Return current value associated with the property corresponding toCNotification.getTlvs()
.org.opendaylight.yangtools.yang.common.Uint8
getType()
Return current value associated with the property corresponding toCNotification.getType()
.org.opendaylight.yangtools.yang.common.Uint8
getValue()
Return current value associated with the property corresponding toCNotification.getValue()
.CNotificationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> augmentationType)
Remove an augmentation from this builder's product.CNotificationBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.CNotificationBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.CNotificationBuilder
setTlvs(Tlvs value)
Set the property corresponding toCNotification.getTlvs()
to the specified value.CNotificationBuilder
setType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toCNotification.getType()
to the specified value.CNotificationBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toCNotification.getValue()
to the specified value.
-
-
-
Constructor Detail
-
CNotificationBuilder
public CNotificationBuilder()
Construct an empty builder.
-
CNotificationBuilder
public CNotificationBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
CNotificationBuilder
public CNotificationBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
CNotificationBuilder
public CNotificationBuilder(CNotification base)
Construct a builder initialized with state from specifiedCNotification
.- Parameters:
base
- CNotification from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getTlvs
public Tlvs getTlvs()
Return current value associated with the property corresponding toCNotification.getTlvs()
.- Returns:
- current value
-
getType
public org.opendaylight.yangtools.yang.common.Uint8 getType()
Return current value associated with the property corresponding toCNotification.getType()
.- Returns:
- current value
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
Return current value associated with the property corresponding toCNotification.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setIgnore
public CNotificationBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public CNotificationBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTlvs
public CNotificationBuilder setTlvs(Tlvs value)
Set the property corresponding toCNotification.getTlvs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
public CNotificationBuilder setType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toCNotification.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public CNotificationBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toCNotification.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CNotificationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CNotification> 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 CNotificationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> 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 @NonNull CNotification build()
A newCNotification
instance.- Returns:
- A new
CNotification
instance.
-
-