Class TlsBuilder

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

    public class TlsBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<Tls>
    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())

    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:
    Tls, Builder
    • Constructor Detail

      • TlsBuilder

        public TlsBuilder()
      • TlsBuilder

        public TlsBuilder​(Tls base)
    • Method Detail

      • getCertificatePassword

        public String getCertificatePassword()
      • getKeystore

        public String getKeystore()
      • getKeystorePassword

        public String getKeystorePassword()
      • getKeystorePathType

        public PathType getKeystorePathType()
      • getKeystoreType

        public StoreType getKeystoreType()
      • getTruststore

        public String getTruststore()
      • getTruststorePassword

        public String getTruststorePassword()
      • getTruststorePathType

        public PathType getTruststorePathType()
      • getTruststoreType

        public StoreType getTruststoreType()
      • augmentation

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

        public TlsBuilder setCertificatePassword​(String value)
      • setTruststorePassword

        public TlsBuilder setTruststorePassword​(String value)
      • addAugmentation

        public TlsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Tls> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        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.
        augmentationType - augmentation type to be removed
        this builder
      • build

        public Tls build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Tls>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Tls,​IllegalArgumentException>