Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.messages.rev180813.messages.state

Class MessageBuilder

  • @Generated("mdsal-binding-generator")
public class MessageBuilder
extends Object
    Class that builds Message 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: 

       
     Message createMessage(int fooXyzzy, int barBaz) {
         return new MessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • MessageBuilder

        public MessageBuilder()
        Construct an empty builder.

      • MessageBuilder

        public MessageBuilder​(Message base)
        Construct a builder initialized with state from specified Message.
        Parameters:
        base - Message from which the builder should be initialized

    • Method Detail

      • getAppName

        public String getAppName()
        Return current value associated with the property corresponding to Message.getAppName().
        Returns:
        current value

      • getMsg

        public String getMsg()
        Return current value associated with the property corresponding to Message.getMsg().
        Returns:
        current value

      • getMsgid

        public String getMsgid()
        Return current value associated with the property corresponding to Message.getMsgid().
        Returns:
        current value

      • getPriority

        public org.opendaylight.yangtools.yang.common.Uint8 getPriority()
        Return current value associated with the property corresponding to Message.getPriority().
        Returns:
        current value

      • getProcid

        public String getProcid()
        Return current value associated with the property corresponding to Message.getProcid().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Message>> 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 - if augmentType is null

      • setAppName

        public MessageBuilder setAppName​(String value)
        Set the property corresponding to Message.getAppName() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMsg

        public MessageBuilder setMsg​(String value)
        Set the property corresponding to Message.getMsg() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMsgid

        public MessageBuilder setMsgid​(String value)
        Set the property corresponding to Message.getMsgid() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPriority

        public MessageBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to Message.getPriority() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setProcid

        public MessageBuilder setProcid​(String value)
        Set the property corresponding to Message.getProcid() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public MessageBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Message> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • removeAugmentation

        public MessageBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Message>> 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