Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109

Class Link1Builder

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

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

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

    • Constructor Detail

      • Link1Builder

        public Link1Builder()

      • Link1Builder

        public Link1Builder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.TunnelAttributes arg)

      • Link1Builder

        public Link1Builder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.Priority arg)

      • Link1Builder

        public Link1Builder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilters arg)

      • Link1Builder

        public Link1Builder​(Link1 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.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.topology.tunnel.pcep.rev181109.TunnelPcepLinkCfgAttributes
        • 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.topology.tunnel.pcep.rev181109.TunnelPcepLinkOperAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getBandwidth

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth getBandwidth()

      • getClassType

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ClassType getClassType()

      • getExcludeAny

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getExcludeAny()

      • getHoldPriority

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

      • getIncludeAll

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getIncludeAll()

      • getIncludeAny

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getIncludeAny()

      • getSessionName

        public String getSessionName()

      • getSetupPriority

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

      • getSymbolicPathName

        public String getSymbolicPathName()

      • isLabelRecordingDesired

        public Boolean isLabelRecordingDesired()

      • isLocalProtectionDesired

        public Boolean isLocalProtectionDesired()

      • isSeStyleDesired

        public Boolean isSeStyleDesired()

      • setBandwidth

        public Link1Builder setBandwidth​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth value)

      • setClassType

        public Link1Builder setClassType​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ClassType value)

      • setExcludeAny

        public Link1Builder setExcludeAny​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)

      • setHoldPriority

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

      • setHoldPriority

        @Deprecated(forRemoval=true)
public Link1Builder 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

      • setIncludeAll

        public Link1Builder setIncludeAll​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)

      • setIncludeAny

        public Link1Builder setIncludeAny​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)

      • setSetupPriority

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

      • setSetupPriority

        @Deprecated(forRemoval=true)
public Link1Builder 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

      • build

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