Class NotifyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.NotifyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Notify>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Notify,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NotifyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Notify>
Class that buildsNotifyBuilder
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:
NotifyBuilder createTarget(int fooXyzzy, int barBaz) { return new NotifyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NotifyBuilder, 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:
NotifyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NotifyBuilder()
NotifyBuilder(Notify base)
NotifyBuilder(NotifyMessage arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NotifyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Notify> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>>
E$$augmentation(Class<E$$> augmentationType)
Notify
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.byte[]
getData()
org.opendaylight.yangtools.yang.common.Uint8
getErrorCode()
org.opendaylight.yangtools.yang.common.Uint8
getErrorSubcode()
NotifyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>> augmentationType)
Remove an augmentation from this builder's product.NotifyBuilder
setData(byte[] value)
NotifyBuilder
setErrorCode(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetErrorCode(Uint8)
instead.NotifyBuilder
setErrorCode(org.opendaylight.yangtools.yang.common.Uint8 value)
NotifyBuilder
setErrorSubcode(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetErrorSubcode(Uint8)
instead.NotifyBuilder
setErrorSubcode(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
NotifyBuilder
public NotifyBuilder()
-
NotifyBuilder
public NotifyBuilder(NotifyMessage arg)
-
NotifyBuilder
public NotifyBuilder(Notify 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.bgp.message.rev200120.NotifyMessage
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getData
public byte[] getData()
-
getErrorCode
public org.opendaylight.yangtools.yang.common.Uint8 getErrorCode()
-
getErrorSubcode
public org.opendaylight.yangtools.yang.common.Uint8 getErrorSubcode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>> E$$ augmentation(Class<E$$> augmentationType)
-
setData
public NotifyBuilder setData(byte[] value)
-
setErrorCode
public NotifyBuilder setErrorCode(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setErrorCode
@Deprecated(forRemoval=true) public NotifyBuilder setErrorCode(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetErrorCode(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setErrorSubcode
public NotifyBuilder setErrorSubcode(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setErrorSubcode
@Deprecated(forRemoval=true) public NotifyBuilder setErrorSubcode(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetErrorSubcode(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NotifyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Notify> 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 NotifyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>> 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 Notify build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Notify>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Notify,IllegalArgumentException>
-
-