Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev181109.sr.pce.capability.tlv

Class SrPceCapabilityBuilder

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

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

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

    • Constructor Detail

      • SrPceCapabilityBuilder

        public SrPceCapabilityBuilder()

      • SrPceCapabilityBuilder

        public SrPceCapabilityBuilder​(Tlv arg)

      • SrPceCapabilityBuilder

        public SrPceCapabilityBuilder​(SrPceCapability 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.Tlv
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getMsd

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

      • augmentation

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

      • setMsd

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