Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.config.rev230112.pcep.config

Class SessionConfigBuilder

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

   
     SessionConfig createSessionConfig(int fooXyzzy, int barBaz) {
         return new SessionConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SessionConfigBuilder

      public SessionConfigBuilder()
      Construct an empty builder.

    • SessionConfigBuilder

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

    • SessionConfigBuilder

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

    • SessionConfigBuilder

      public SessionConfigBuilder(SessionConfig base)
      Construct a builder initialized with state from specified SessionConfig.
      Parameters:
      base - SessionConfig 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

    • empty

      public static @NonNull SessionConfig empty()
      Get empty instance of SessionConfig.
      Returns:
      An empty SessionConfig

    • getDeadTimerValue

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

    • getKeepAliveTimerValue

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

    • getListenAddress

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getListenAddress()
      Return current value associated with the property corresponding to SessionConfig.getListenAddress().
      Returns:
      current value

    • getListenPort

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getListenPort()
      Return current value associated with the property corresponding to SessionConfig.getListenPort().
      Returns:
      current value

    • getMaxUnknownMessages

      public org.opendaylight.yangtools.yang.common.Uint16 getMaxUnknownMessages()
      Return current value associated with the property corresponding to PcepSessionErrorPolicy.getMaxUnknownMessages().
      Returns:
      current value

    • getRpcTimeout

      public Short getRpcTimeout()
      Return current value associated with the property corresponding to SessionConfig.getRpcTimeout().
      Returns:
      current value

    • getTls

      public Tls getTls()
      Return current value associated with the property corresponding to SessionConfig.getTls().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> 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

    • setDeadTimerValue

      public SessionConfigBuilder setDeadTimerValue(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to PcepSessionTimers.getDeadTimerValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setKeepAliveTimerValue

      public SessionConfigBuilder setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to PcepSessionTimers.getKeepAliveTimerValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setListenAddress

      public SessionConfigBuilder setListenAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
      Set the property corresponding to SessionConfig.getListenAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setListenPort

      public SessionConfigBuilder setListenPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
      Set the property corresponding to SessionConfig.getListenPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxUnknownMessages

      public SessionConfigBuilder setMaxUnknownMessages(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to PcepSessionErrorPolicy.getMaxUnknownMessages() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRpcTimeout

      public SessionConfigBuilder setRpcTimeout(Short value)
      Set the property corresponding to SessionConfig.getRpcTimeout() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTls

      public SessionConfigBuilder setTls(Tls value)
      Set the property corresponding to SessionConfig.getTls() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public SessionConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig> 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 SessionConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> 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 SessionConfig build()
      A new SessionConfig instance.
      Returns:
      A new SessionConfig instance.