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

Class PcepUpdateTunnelInputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PcepUpdateTunnelInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<PcepUpdateTunnelInput,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class PcepUpdateTunnelInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PcepUpdateTunnelInput>
    Class that builds PcepUpdateTunnelInput 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: 

       
     PcepUpdateTunnelInput createPcepUpdateTunnelInput(int fooXyzzy, int barBaz) {
         return new PcepUpdateTunnelInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PcepUpdateTunnelInputBuilder

        public PcepUpdateTunnelInputBuilder()

      • PcepUpdateTunnelInputBuilder

        public PcepUpdateTunnelInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.BaseTunnelInput arg)

      • PcepUpdateTunnelInputBuilder

        public PcepUpdateTunnelInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.programming.rev131102.TopologyInstructionInput arg)

      • PcepUpdateTunnelInputBuilder

        public PcepUpdateTunnelInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.SubmitInstructionInput arg)

      • PcepUpdateTunnelInputBuilder

        public PcepUpdateTunnelInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyReference arg)

      • PcepUpdateTunnelInputBuilder

        public PcepUpdateTunnelInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.TunnelP2pPathCfgAttributes arg)

      • PcepUpdateTunnelInputBuilder

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

      • PcepUpdateTunnelInputBuilder

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

      • PcepUpdateTunnelInputBuilder

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

    • 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:
        • TopologyInstructionInput
        • SubmitInstructionInput
        • TunnelP2pPathCfgAttributes
        • Priority
        • AttributeFilters
        • NetworkTopologyReference
        • TunnelPcepLinkCfgAttributes
        • BaseTunnelInput
        • TunnelAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

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

      • getDeadline

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.Nanotime getDeadline()

      • getExcludeAny

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

      • getExplicitHops

        public Map<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.cfg.attributes.ExplicitHopsKey,​org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.cfg.attributes.ExplicitHops> getExplicitHops()

      • getHoldPriority

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

      • getId

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId getId()

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

      • getLabelRecordingDesired

        public Boolean getLabelRecordingDesired()

      • getLinkId

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getLinkId()

      • getLocalProtectionDesired

        public Boolean getLocalProtectionDesired()

      • getNetworkTopologyRef

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyRef getNetworkTopologyRef()

      • getPreconditions

        public List<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId> getPreconditions()

      • getSeStyleDesired

        public Boolean getSeStyleDesired()

      • getSessionName

        public String getSessionName()

      • getSetupPriority

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

      • getSymbolicPathName

        public String getSymbolicPathName()

      • augmentation

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

      • setBandwidth

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

      • setClassType

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

      • setDeadline

        public PcepUpdateTunnelInputBuilder setDeadline​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.Nanotime value)

      • setExcludeAny

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

      • setExplicitHops

        public PcepUpdateTunnelInputBuilder setExplicitHops​(Map<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.cfg.attributes.ExplicitHopsKey,​org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.cfg.attributes.ExplicitHops> values)

      • setId

        public PcepUpdateTunnelInputBuilder setId​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId value)

      • setIncludeAll

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

      • setIncludeAny

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

      • setLinkId

        public PcepUpdateTunnelInputBuilder setLinkId​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)

      • setNetworkTopologyRef

        public PcepUpdateTunnelInputBuilder setNetworkTopologyRef​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyRef value)

      • setPreconditions

        public PcepUpdateTunnelInputBuilder setPreconditions​(List<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId> values)

      • removeAugmentation

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