Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class ErrorMessageBuilder

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

       
     ErrorMessage createErrorMessage(int fooXyzzy, int barBaz) {
         return new ErrorMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • ErrorMessageBuilder

        public ErrorMessageBuilder()
        Construct an empty builder.

      • ErrorMessageBuilder

        public ErrorMessageBuilder​(Error arg)
        Construct a new builder initialized from specified Error.
        Parameters:
        arg - Error from which the builder should be initialized

      • ErrorMessageBuilder

        public ErrorMessageBuilder​(OfHeader arg)
        Construct a new builder initialized from specified OfHeader.
        Parameters:
        arg - OfHeader from which the builder should be initialized

      • ErrorMessageBuilder

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

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getCode

        public org.opendaylight.yangtools.yang.common.Uint16 getCode()
        Return current value associated with the property corresponding to Error.getCode().
        Returns:
        current value

      • getCodeString

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

      • getData

        public byte[] getData()
        Return current value associated with the property corresponding to Error.getData().
        Returns:
        current value

      • getType

        public org.opendaylight.yangtools.yang.common.Uint16 getType()
        Return current value associated with the property corresponding to Error.getType().
        Returns:
        current value

      • getTypeString

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

      • getVersion

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

      • getXid

        public org.opendaylight.yangtools.yang.common.Uint32 getXid()
        Return current value associated with the property corresponding to OfHeader.getXid().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>> 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

      • setCode

        public ErrorMessageBuilder setCode​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to Error.getCode() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setData

        public ErrorMessageBuilder setData​(byte[] value)
        Set the property corresponding to Error.getData() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setType

        public ErrorMessageBuilder setType​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to Error.getType() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setVersion

        public ErrorMessageBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to OfHeader.getVersion() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setXid

        public ErrorMessageBuilder setXid​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to OfHeader.getXid() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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