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>
    @Generated("mdsal-binding-generator")
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 or has property with incompatible value

      • getBiDirectional

        public Boolean getBiDirectional()

      • isBiDirectional

        @Deprecated(forRemoval=true)
public final Boolean isBiDirectional()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getEroCompression

        public Boolean getEroCompression()

      • isEroCompression

        @Deprecated(forRemoval=true)
public final Boolean isEroCompression()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getFragmentation

        public Boolean getFragmentation()

      • isFragmentation

        @Deprecated(forRemoval=true)
public final Boolean isFragmentation()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getIgnore

        public Boolean getIgnore()

      • isIgnore

        @Deprecated(forRemoval=true)
public final Boolean isIgnore()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getLoose

        public Boolean getLoose()

      • isLoose

        @Deprecated(forRemoval=true)
public final Boolean isLoose()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getMakeBeforeBreak

        public Boolean getMakeBeforeBreak()

      • isMakeBeforeBreak

        @Deprecated(forRemoval=true)
public final Boolean isMakeBeforeBreak()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getOrder

        public Boolean getOrder()

      • isOrder

        @Deprecated(forRemoval=true)
public final Boolean isOrder()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getP2mp

        public Boolean getP2mp()

      • isP2mp

        @Deprecated(forRemoval=true)
public final Boolean isP2mp()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getPathKey

        public Boolean getPathKey()

      • isPathKey

        @Deprecated(forRemoval=true)
public final Boolean isPathKey()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getPriority

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

      • getProcessingRule

        public Boolean getProcessingRule()

      • isProcessingRule

        @Deprecated(forRemoval=true)
public final Boolean isProcessingRule()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getReoptimization

        public Boolean getReoptimization()

      • isReoptimization

        @Deprecated(forRemoval=true)
public final Boolean isReoptimization()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getRequestId

        public RequestId getRequestId()

      • getSupplyOf

        public Boolean getSupplyOf()

      • isSupplyOf

        @Deprecated(forRemoval=true)
public final Boolean isSupplyOf()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getTlvs

        public Tlvs getTlvs()

      • 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 setPriority(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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

      • 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>