Class ErrorMessageBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<ErrorMessage>, org.opendaylight.yangtools.concepts.CheckedBuilder<ErrorMessage,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class ErrorMessageBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<ErrorMessage>
    Class that builds ErrorMessageBuilder 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:

         ErrorMessageBuilder createTarget(int fooXyzzy, int barBaz) {
             return new ErrorMessageBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • ErrorMessageBuilder

        public ErrorMessageBuilder()
      • ErrorMessageBuilder

        public ErrorMessageBuilder​(Error arg)
      • ErrorMessageBuilder

        public ErrorMessageBuilder​(OfHeader arg)
      • ErrorMessageBuilder

        public ErrorMessageBuilder​(ErrorMessage 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.openflow.protocol.rev130731.OfHeader
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getCode

        public org.opendaylight.yangtools.yang.common.Uint16 getCode()
      • getCodeString

        public String getCodeString()
      • getData

        public byte[] getData()
      • getType

        public org.opendaylight.yangtools.yang.common.Uint16 getType()
      • getTypeString

        public String getTypeString()
      • getVersion

        public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
      • getXid

        public org.opendaylight.yangtools.yang.common.Uint32 getXid()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage>> E$$ augmentation​(Class<E$$> augmentationType)
      • setCode

        public ErrorMessageBuilder setCode​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setType

        public ErrorMessageBuilder setType​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setVersion

        public ErrorMessageBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setXid

        public ErrorMessageBuilder setXid​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setXid

        public ErrorMessageBuilder setXid​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setXid(Uint32) instead.
        Utility migration setter.
        value - field value in legacy type
        this builder
      • addAugmentation

        public ErrorMessageBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<ErrorMessage> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        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.
        augmentationType - augmentation type to be removed
        this builder