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

Class Link1Builder

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

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

This pattern is supported by the immutable nature of Link1, 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 Details

    • Link1Builder

      public Link1Builder()
      Construct an empty builder.

    • Link1Builder

      public Link1Builder(TunnelPcepLinkCfgAttributes arg)
      Construct a new builder initialized from specified TunnelPcepLinkCfgAttributes.
      Parameters:
      arg - TunnelPcepLinkCfgAttributes from which the builder should be initialized

    • Link1Builder

      public Link1Builder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.TunnelAttributes arg)
      Construct a new builder initialized from specified TunnelAttributes.
      Parameters:
      arg - TunnelAttributes from which the builder should be initialized

    • Link1Builder

      public Link1Builder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.Priority arg)
      Construct a new builder initialized from specified Priority.
      Parameters:
      arg - Priority from which the builder should be initialized

    • Link1Builder

      public Link1Builder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilters arg)
      Construct a new builder initialized from specified AttributeFilters.
      Parameters:
      arg - AttributeFilters from which the builder should be initialized

    • Link1Builder

      public Link1Builder(TunnelPcepLinkOperAttributes arg)
      Construct a new builder initialized from specified TunnelPcepLinkOperAttributes.
      Parameters:
      arg - TunnelPcepLinkOperAttributes from which the builder should be initialized

    • Link1Builder

      public Link1Builder(Link1 base)
      Construct a builder initialized with state from specified Link1.
      Parameters:
      base - Link1 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:
      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()
      Return current value associated with the property corresponding to TunnelPcepLinkCfgAttributes.getBandwidth().
      Returns:
      current value

    • getClassType

      public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ClassType getClassType()
      Return current value associated with the property corresponding to TunnelPcepLinkCfgAttributes.getClassType().
      Returns:
      current value

    • getExcludeAny

      public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getExcludeAny()
      Return current value associated with the property corresponding to AttributeFilters.getExcludeAny().
      Returns:
      current value

    • getHoldPriority

      public org.opendaylight.yangtools.yang.common.Uint8 getHoldPriority()
      Return current value associated with the property corresponding to Priority.getHoldPriority().
      Returns:
      current value

    • getIncludeAll

      public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getIncludeAll()
      Return current value associated with the property corresponding to AttributeFilters.getIncludeAll().
      Returns:
      current value

    • getIncludeAny

      public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter getIncludeAny()
      Return current value associated with the property corresponding to AttributeFilters.getIncludeAny().
      Returns:
      current value

    • getLabelRecordingDesired

      public Boolean getLabelRecordingDesired()
      Return current value associated with the property corresponding to TunnelAttributes.getLabelRecordingDesired().
      Returns:
      current value

    • getLocalProtectionDesired

      public Boolean getLocalProtectionDesired()
      Return current value associated with the property corresponding to TunnelAttributes.getLocalProtectionDesired().
      Returns:
      current value

    • getSeStyleDesired

      public Boolean getSeStyleDesired()
      Return current value associated with the property corresponding to TunnelAttributes.getSeStyleDesired().
      Returns:
      current value

    • getSessionName

      public String getSessionName()
      Return current value associated with the property corresponding to TunnelAttributes.getSessionName().
      Returns:
      current value

    • getSetupPriority

      public org.opendaylight.yangtools.yang.common.Uint8 getSetupPriority()
      Return current value associated with the property corresponding to Priority.getSetupPriority().
      Returns:
      current value

    • getSymbolicPathName

      public String getSymbolicPathName()
      Return current value associated with the property corresponding to TunnelPcepLinkCfgAttributes.getSymbolicPathName().
      Returns:
      current value

    • setBandwidth

      public Link1Builder setBandwidth(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth value)
      Set the property corresponding to TunnelPcepLinkCfgAttributes.getBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setClassType

      public Link1Builder setClassType(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ClassType value)
      Set the property corresponding to TunnelPcepLinkCfgAttributes.getClassType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setExcludeAny

      public Link1Builder setExcludeAny(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)
      Set the property corresponding to AttributeFilters.getExcludeAny() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHoldPriority

      public Link1Builder setHoldPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Priority.getHoldPriority() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIncludeAll

      public Link1Builder setIncludeAll(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)
      Set the property corresponding to AttributeFilters.getIncludeAll() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIncludeAny

      public Link1Builder setIncludeAny(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.AttributeFilter value)
      Set the property corresponding to AttributeFilters.getIncludeAny() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLabelRecordingDesired

      public Link1Builder setLabelRecordingDesired(Boolean value)
      Set the property corresponding to TunnelAttributes.getLabelRecordingDesired() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalProtectionDesired

      public Link1Builder setLocalProtectionDesired(Boolean value)
      Set the property corresponding to TunnelAttributes.getLocalProtectionDesired() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSeStyleDesired

      public Link1Builder setSeStyleDesired(Boolean value)
      Set the property corresponding to TunnelAttributes.getSeStyleDesired() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSessionName

      public Link1Builder setSessionName(String value)
      Set the property corresponding to TunnelAttributes.getSessionName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSetupPriority

      public Link1Builder setSetupPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Priority.getSetupPriority() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSymbolicPathName

      public Link1Builder setSymbolicPathName(String value)
      Set the property corresponding to TunnelPcepLinkCfgAttributes.getSymbolicPathName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

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