Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.rpki.config.cache.server.config.transport

Class SshBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Ssh>, org.opendaylight.yangtools.concepts.CheckedBuilder<Ssh,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class SshBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<Ssh>
    Class that builds SshBuilder 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: 

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      SshBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ssh>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ssh> augmentationValue)  
      <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ssh>>
      E$$      		 augmentation​(java.lang.Class<E$$> augmentationType)  
      Ssh build()  
      org.opendaylight.yangtools.yang.common.Uint32 getSshPort()  
      SshBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ssh>> augmentationType)  
      SshBuilder setSshPort​(java.lang.Long value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use {#link setSshPort(Uint32)} instead.
      SshBuilder setSshPort​(org.opendaylight.yangtools.yang.common.Uint32 value)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SshBuilder

        public SshBuilder()

      • SshBuilder

        public SshBuilder​(Ssh base)

    • Method Detail

      • getSshPort

        public org.opendaylight.yangtools.yang.common.Uint32 getSshPort()

      • augmentation

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

      • setSshPort

        public SshBuilder setSshPort​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setSshPort

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

      • addAugmentation

        public SshBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ssh>> augmentationType,
                                  org.opendaylight.yangtools.yang.binding.Augmentation<Ssh> augmentationValue)

      • removeAugmentation

        public SshBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ssh>> augmentationType)

      • build

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