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

Class TlsBuilder

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

   
     Tls createTls(int fooXyzzy, int barBaz) {
         return new TlsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TlsBuilder

      public TlsBuilder()
      Construct an empty builder.

    • TlsBuilder

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

    • TlsBuilder

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

    • getCertificatePassword

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

    • getKeystore

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

    • getKeystorePassword

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

    • getKeystorePathType

      public PathType getKeystorePathType()
      Return current value associated with the property corresponding to PcepSessionTls.getKeystorePathType().
      Returns:
      current value

    • getKeystoreType

      public StoreType getKeystoreType()
      Return current value associated with the property corresponding to PcepSessionTls.getKeystoreType().
      Returns:
      current value

    • getTruststore

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

    • getTruststorePassword

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

    • getTruststorePathType

      public PathType getTruststorePathType()
      Return current value associated with the property corresponding to PcepSessionTls.getTruststorePathType().
      Returns:
      current value

    • getTruststoreType

      public StoreType getTruststoreType()
      Return current value associated with the property corresponding to PcepSessionTls.getTruststoreType().
      Returns:
      current value

    • augmentation

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

    • setCertificatePassword

      public TlsBuilder setCertificatePassword(String value)
      Set the property corresponding to PcepSessionTls.getCertificatePassword() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setKeystore

      public TlsBuilder setKeystore(String value)
      Set the property corresponding to PcepSessionTls.getKeystore() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setKeystorePassword

      public TlsBuilder setKeystorePassword(String value)
      Set the property corresponding to PcepSessionTls.getKeystorePassword() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setKeystorePathType

      public TlsBuilder setKeystorePathType(PathType value)
      Set the property corresponding to PcepSessionTls.getKeystorePathType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setKeystoreType

      public TlsBuilder setKeystoreType(StoreType value)
      Set the property corresponding to PcepSessionTls.getKeystoreType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTruststore

      public TlsBuilder setTruststore(String value)
      Set the property corresponding to PcepSessionTls.getTruststore() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTruststorePassword

      public TlsBuilder setTruststorePassword(String value)
      Set the property corresponding to PcepSessionTls.getTruststorePassword() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTruststorePathType

      public TlsBuilder setTruststorePathType(PathType value)
      Set the property corresponding to PcepSessionTls.getTruststorePathType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTruststoreType

      public TlsBuilder setTruststoreType(StoreType value)
      Set the property corresponding to PcepSessionTls.getTruststoreType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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