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

Class PcepDestroyTunnelInputBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev181109.PcepDestroyTunnelInputBuilder
@Generated("mdsal-binding-generator") public class PcepDestroyTunnelInputBuilder extends Object
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:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PcepDestroyTunnelInputBuilder()
    Construct an empty builder.
    PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyReference arg)
    Construct a new builder initialized from specified NetworkTopologyReference.
    PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.SubmitInstructionInput arg)
    Construct a new builder initialized from specified SubmitInstructionInput.
    PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.programming.rev131102.TopologyInstructionInput arg)
    Construct a new builder initialized from specified TopologyInstructionInput.
    PcepDestroyTunnelInputBuilder(PcepDestroyTunnelInput base)
    Construct a builder initialized with state from specified PcepDestroyTunnelInput.
    PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.BaseTunnelInput arg)
    Construct a new builder initialized from specified BaseTunnelInput.
    PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.DestroyTunnelInput arg)
    Construct a new builder initialized from specified DestroyTunnelInput.

  • Method Summary

    Modifier and Type
    Method
    Description
    PcepDestroyTunnelInputBuilder
    addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput> augmentation)
    Add an augmentation to this builder's product.
    <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput>>
    E$$
    augmentation(Class<E$$> augmentationType)
    Return the specified augmentation, if it is present in this builder.
    @NonNull PcepDestroyTunnelInput
    build()
    A new PcepDestroyTunnelInput instance.
    void
    fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
    Set fields from given grouping argument.
    org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.Nanotime
    getDeadline()
    Return current value associated with the property corresponding to SubmitInstructionInput.getDeadline().
    org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId
    getId()
    Return current value associated with the property corresponding to SubmitInstructionInput.getId().
    org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId
    getLinkId()
    Return current value associated with the property corresponding to BaseTunnelInput.getLinkId().
    org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyRef
    getNetworkTopologyRef()
    Return current value associated with the property corresponding to NetworkTopologyReference.getNetworkTopologyRef().
    Set<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId>
    getPreconditions()
    Return current value associated with the property corresponding to SubmitInstructionInput.getPreconditions().
    PcepDestroyTunnelInputBuilder
    removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput>> augmentationType)
    Remove an augmentation from this builder's product.
    PcepDestroyTunnelInputBuilder
    setDeadline(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.Nanotime value)
    Set the property corresponding to SubmitInstructionInput.getDeadline() to the specified value.
    PcepDestroyTunnelInputBuilder
    setId(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId value)
    Set the property corresponding to SubmitInstructionInput.getId() to the specified value.
    PcepDestroyTunnelInputBuilder
    setLinkId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)
    Set the property corresponding to BaseTunnelInput.getLinkId() to the specified value.
    PcepDestroyTunnelInputBuilder
    setNetworkTopologyRef(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyRef value)
    Set the property corresponding to NetworkTopologyReference.getNetworkTopologyRef() to the specified value.
    PcepDestroyTunnelInputBuilder
    setPreconditions(Set<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId> values)
    Set the property corresponding to SubmitInstructionInput.getPreconditions() to the specified value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PcepDestroyTunnelInputBuilder

      public PcepDestroyTunnelInputBuilder()
      Construct an empty builder.

    • PcepDestroyTunnelInputBuilder

      public PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.DestroyTunnelInput arg)
      Construct a new builder initialized from specified DestroyTunnelInput.
      Parameters:
      arg - DestroyTunnelInput from which the builder should be initialized

    • PcepDestroyTunnelInputBuilder

      public PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.BaseTunnelInput arg)
      Construct a new builder initialized from specified BaseTunnelInput.
      Parameters:
      arg - BaseTunnelInput from which the builder should be initialized

    • PcepDestroyTunnelInputBuilder

      public PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.programming.rev131102.TopologyInstructionInput arg)
      Construct a new builder initialized from specified TopologyInstructionInput.
      Parameters:
      arg - TopologyInstructionInput from which the builder should be initialized

    • PcepDestroyTunnelInputBuilder

      public PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.SubmitInstructionInput arg)
      Construct a new builder initialized from specified SubmitInstructionInput.
      Parameters:
      arg - SubmitInstructionInput from which the builder should be initialized

    • PcepDestroyTunnelInputBuilder

      public PcepDestroyTunnelInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyReference arg)
      Construct a new builder initialized from specified NetworkTopologyReference.
      Parameters:
      arg - NetworkTopologyReference from which the builder should be initialized

    • PcepDestroyTunnelInputBuilder

      public PcepDestroyTunnelInputBuilder(PcepDestroyTunnelInput base)
      Construct a builder initialized with state from specified PcepDestroyTunnelInput.
      Parameters:
      base - PcepDestroyTunnelInput from which the builder should be initialized

  • Method Details

    • 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()
      Return current value associated with the property corresponding to SubmitInstructionInput.getDeadline().
      Returns:
      current value

    • getId

      public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId getId()
      Return current value associated with the property corresponding to SubmitInstructionInput.getId().
      Returns:
      current value

    • getLinkId

      public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getLinkId()
      Return current value associated with the property corresponding to BaseTunnelInput.getLinkId().
      Returns:
      current value

    • getNetworkTopologyRef

      public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyRef getNetworkTopologyRef()
      Return current value associated with the property corresponding to NetworkTopologyReference.getNetworkTopologyRef().
      Returns:
      current value

    • getPreconditions

      public Set<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId> getPreconditions()
      Return current value associated with the property corresponding to SubmitInstructionInput.getPreconditions().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • setDeadline

      public PcepDestroyTunnelInputBuilder setDeadline(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.Nanotime value)
      Set the property corresponding to SubmitInstructionInput.getDeadline() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setId

      public PcepDestroyTunnelInputBuilder setId(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId value)
      Set the property corresponding to SubmitInstructionInput.getId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLinkId

      public PcepDestroyTunnelInputBuilder setLinkId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)
      Set the property corresponding to BaseTunnelInput.getLinkId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNetworkTopologyRef

      public PcepDestroyTunnelInputBuilder setNetworkTopologyRef(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyRef value)
      Set the property corresponding to NetworkTopologyReference.getNetworkTopologyRef() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPreconditions

      public PcepDestroyTunnelInputBuilder setPreconditions(Set<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionId> values)
      Set the property corresponding to SubmitInstructionInput.getPreconditions() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

      public PcepDestroyTunnelInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput> augmentation)
      Add an augmentation to this builder's product.
      Parameters:
      augmentation - augmentation to be added
      Returns:
      this builder
      Throws:
      NullPointerException - if augmentation is null

    • 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

    • build

      public @NonNull PcepDestroyTunnelInput build()
      A new PcepDestroyTunnelInput instance.
      Returns:
      A new PcepDestroyTunnelInput instance.