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

Class HostNameBuilder

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

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

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

    • Constructor Detail

      • HostNameBuilder

        public HostNameBuilder()

      • HostNameBuilder

        public HostNameBuilder​(HostName base)

    • Method Detail

      • getIpHostAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host getIpHostAddress()

      • augmentation

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

      • setIpHostAddress

        public HostNameBuilder setIpHostAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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