Class PcepDestroyTunnelInputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PcepDestroyTunnelInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<PcepDestroyTunnelInput,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    @Generated("mdsal-binding-generator")
    public class PcepDestroyTunnelInputBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<PcepDestroyTunnelInput>
    Class that builds PcepDestroyTunnelInput 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:

       
         PcepDestroyTunnelInput createPcepDestroyTunnelInput(int fooXyzzy, int barBaz) {
             return new PcepDestroyTunnelInputBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • PcepDestroyTunnelInputBuilder

        public PcepDestroyTunnelInputBuilder()
      • PcepDestroyTunnelInputBuilder

        public PcepDestroyTunnelInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.DestroyTunnelInput arg)
      • PcepDestroyTunnelInputBuilder

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

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

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

        public PcepDestroyTunnelInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyReference 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:
        • DestroyTunnelInput
        • TopologyInstructionInput
        • SubmitInstructionInput
        • NetworkTopologyReference
        • BaseTunnelInput
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getDeadline

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

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

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getLinkId()
      • 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()
      • augmentation

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

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

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

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

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

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

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