Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object

Class RpBuilder

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

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

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

    • Constructor Detail

      • RpBuilder

        public RpBuilder()

      • RpBuilder

        public RpBuilder​(Object arg)

      • RpBuilder

        public RpBuilder​(Rp 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.pcep.types.rev181109.ObjectHeader
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getPriority

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

      • getRequestId

        public RequestId getRequestId()

      • getTlvs

        public Tlvs getTlvs()

      • isBiDirectional

        public Boolean isBiDirectional()

      • isEroCompression

        public Boolean isEroCompression()

      • isFragmentation

        public Boolean isFragmentation()

      • isIgnore

        public Boolean isIgnore()

      • isLoose

        public Boolean isLoose()

      • isMakeBeforeBreak

        public Boolean isMakeBeforeBreak()

      • isOrder

        public Boolean isOrder()

      • isPathKey

        public Boolean isPathKey()

      • isProcessingRule

        public Boolean isProcessingRule()

      • isReoptimization

        public Boolean isReoptimization()

      • isSupplyOf

        public Boolean isSupplyOf()

      • augmentation

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

      • setPriority

        public RpBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setPriority

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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