Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.down.data.notification

Class NotificationBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Notification>, org.opendaylight.yangtools.concepts.CheckedBuilder<Notification,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class NotificationBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Notification>
    Class that builds NotificationBuilder 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: 

       
     NotificationBuilder createTarget(int fooXyzzy, int barBaz) {
         return new NotificationBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

    This pattern is supported by the immutable nature of NotificationBuilder, 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:
    NotificationBuilder, Builder

    • Constructor Detail

      • NotificationBuilder

        public NotificationBuilder()

      • NotificationBuilder

        public NotificationBuilder​(NotifyMessage arg)

      • NotificationBuilder

        public NotificationBuilder​(Notification 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

      • 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<Notification>> E$$ augmentation​(Class<E$$> augmentationType)

      • setErrorCode

        public NotificationBuilder setErrorCode​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setErrorCode

        @Deprecated(forRemoval=true)
public NotificationBuilder setErrorCode​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setErrorCode(Uint8)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setErrorSubcode

        public NotificationBuilder setErrorSubcode​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setErrorSubcode

        @Deprecated(forRemoval=true)
public NotificationBuilder setErrorSubcode​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setErrorSubcode(Uint8)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

        public NotificationBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notification>> augmentationType,
                                           org.opendaylight.yangtools.yang.binding.Augmentation<Notification> augmentationValue)