Class CacheServerConfigBuilder

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

    public class CacheServerConfigBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<CacheServerConfig>
    Class that builds CacheServerConfigBuilder 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:

       
         CacheServerConfigBuilder createTarget(int fooXyzzy, int barBaz) {
             return new CacheServerConfigBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

    This pattern is supported by the immutable nature of CacheServerConfigBuilder, 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 oportunities, 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:
    CacheServerConfigBuilder, Builder
    • Constructor Detail

      • CacheServerConfigBuilder

        public CacheServerConfigBuilder()
      • CacheServerConfigBuilder

        public CacheServerConfigBuilder​(CacheServerConfig base)
    • Method Detail

      • getPassword

        public java.lang.String getPassword()
      • getPreferenceValue

        public org.opendaylight.yangtools.yang.common.Uint8 getPreferenceValue()
      • getPurgeTime

        public org.opendaylight.yangtools.yang.common.Uint16 getPurgeTime()
      • getServer

        public Server getServer()
      • getTransport

        public Transport getTransport()
      • getUserName

        public java.lang.String getUserName()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CacheServerConfig>> E$$ augmentation​(java.lang.Class<E$$> augmentationType)
      • setPreferenceValue

        public CacheServerConfigBuilder setPreferenceValue​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setPreferenceValue

        @Deprecated(forRemoval=true)
        public CacheServerConfigBuilder setPreferenceValue​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setPreferenceValue(Uint8)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setPurgeTime

        @Deprecated(forRemoval=true)
        public CacheServerConfigBuilder setPurgeTime​(java.lang.Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setPurgeTime(Uint16)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • build

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