Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120

Class 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>
    public class NotifyBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Notify>
    Class that builds NotifyBuilder 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 Detail

      • NotifyBuilder

        public NotifyBuilder()

      • 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

      • 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)

      • 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.
        Use {#link setErrorCode(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.
        Use {#link setErrorSubcode(Uint8)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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

      • removeAugmentation

        public NotifyBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Notify>> augmentationType)

      • build

        public Notify build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Notify>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Notify,​IllegalArgumentException>