Class Ipv6SrcBuilder

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

    public class Ipv6SrcBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<Ipv6Src>
    Class that builds Ipv6SrcBuilder 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:

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

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

      • Ipv6SrcBuilder

        public Ipv6SrcBuilder()
      • Ipv6SrcBuilder

        public Ipv6SrcBuilder​(Ipv6Src base)
    • Method Detail

      • getIpv6Address

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6Address()
      • getMask

        public byte[] getMask()
      • augmentation

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

        public Ipv6SrcBuilder setIpv6Address​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
      • addAugmentation

        public Ipv6SrcBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src>> augmentationType,
                                              org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src> augmentationValue)
      • removeAugmentation

        public Ipv6SrcBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src>> augmentationType)
      • build

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