Class CNotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.notification.object.CNotificationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<CNotification>
,org.opendaylight.yangtools.concepts.CheckedBuilder<CNotification,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class CNotificationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<CNotification>
Class that buildsCNotificationBuilder
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:
CNotificationBuilder createTarget(int fooXyzzy, int barBaz) { return new CNotificationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CNotificationBuilder, 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:
CNotificationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CNotificationBuilder()
CNotificationBuilder(CNotification base)
CNotificationBuilder(Object arg)
CNotificationBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CNotificationBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CNotification> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>>
E$$augmentation(Class<E$$> augmentationType)
CNotification
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Tlvs
getTlvs()
org.opendaylight.yangtools.yang.common.Uint8
getType()
org.opendaylight.yangtools.yang.common.Uint8
getValue()
Boolean
isIgnore()
Boolean
isProcessingRule()
CNotificationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> augmentationType)
CNotificationBuilder
setIgnore(Boolean value)
CNotificationBuilder
setProcessingRule(Boolean value)
CNotificationBuilder
setTlvs(Tlvs value)
CNotificationBuilder
setType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setType(Uint8)} instead.CNotificationBuilder
setType(org.opendaylight.yangtools.yang.common.Uint8 value)
CNotificationBuilder
setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint8)} instead.CNotificationBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
CNotificationBuilder
public CNotificationBuilder()
-
CNotificationBuilder
public CNotificationBuilder(Object arg)
-
CNotificationBuilder
public CNotificationBuilder(ObjectHeader arg)
-
CNotificationBuilder
public CNotificationBuilder(CNotification 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.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getTlvs
public Tlvs getTlvs()
-
getType
public org.opendaylight.yangtools.yang.common.Uint8 getType()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> E$$ augmentation(Class<E$$> augmentationType)
-
setTlvs
public CNotificationBuilder setTlvs(Tlvs value)
-
setType
public CNotificationBuilder setType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setType
@Deprecated(forRemoval=true) public CNotificationBuilder setType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setType(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setValue
public CNotificationBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
@Deprecated(forRemoval=true) public CNotificationBuilder setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIgnore
public CNotificationBuilder setIgnore(Boolean value)
-
setProcessingRule
public CNotificationBuilder setProcessingRule(Boolean value)
-
addAugmentation
public CNotificationBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CNotification> augmentationValue)
-
removeAugmentation
public CNotificationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CNotification>> augmentationType)
-
build
public CNotification build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<CNotification>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<CNotification,IllegalArgumentException>
-
-