Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.rsvp.error.spec.tlv.rsvp.error.spec.error.type.user._case

Class UserErrorBuilder

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

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

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

    • Constructor Detail

      • UserErrorBuilder

        public UserErrorBuilder()

      • UserErrorBuilder

        public UserErrorBuilder​(UserErrorSpec arg)

      • UserErrorBuilder

        public UserErrorBuilder​(UserError 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.rsvp.rev150820.UserErrorSpec
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getDescription

        public String getDescription()

      • getSubOrg

        public org.opendaylight.yangtools.yang.common.Uint8 getSubOrg()

      • getSubobjects

        public Subobjects getSubobjects()

      • getValue

        public org.opendaylight.yangtools.yang.common.Uint16 getValue()

      • augmentation

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

      • setSubOrg

        public UserErrorBuilder setSubOrg​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setSubOrg

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

      • setValue

        public UserErrorBuilder setValue​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setValue

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

      • addAugmentation

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

      • removeAugmentation

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