Class P2mpIpv4CaseBuilder

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

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

         P2mpIpv4Case createP2mpIpv4Case(int fooXyzzy, int barBaz) {
             return new P2mpIpv4CaseBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • P2mpIpv4CaseBuilder

        public P2mpIpv4CaseBuilder()
      • P2mpIpv4CaseBuilder

        public P2mpIpv4CaseBuilder​(P2mpIpv4Case base)
    • Method Detail

      • getP2mpIpv4

        public P2mpIpv4 getP2mpIpv4()
      • augmentation

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

        public P2mpIpv4CaseBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4Case> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

        public P2mpIpv4CaseBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4Case>> 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