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

Class LspaBuilder

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

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

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

    • Constructor Detail

      • LspaBuilder

        public LspaBuilder()

      • LspaBuilder

        public LspaBuilder​(Object arg)

      • LspaBuilder

        public LspaBuilder​(Priority arg)

      • LspaBuilder

        public LspaBuilder​(Lspa 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.rsvp.rev150820.Priority
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilters
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.TunnelAttributes
        • 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

      • getHoldPriority

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

      • getSessionName

        public String getSessionName()

      • getSetupPriority

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

      • getTlvs

        public Tlvs getTlvs()

      • isIgnore

        public Boolean isIgnore()

      • isLabelRecordingDesired

        public Boolean isLabelRecordingDesired()

      • isLocalProtectionDesired

        public Boolean isLocalProtectionDesired()

      • isProcessingRule

        public Boolean isProcessingRule()

      • isSeStyleDesired

        public Boolean isSeStyleDesired()

      • augmentation

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

      • setHoldPriority

        public LspaBuilder setHoldPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setHoldPriority

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

      • setSetupPriority

        public LspaBuilder setSetupPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setSetupPriority

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

      • setLabelRecordingDesired

        public LspaBuilder setLabelRecordingDesired​(Boolean value)

      • setLocalProtectionDesired

        public LspaBuilder setLocalProtectionDesired​(Boolean value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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