Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rpc.rev170209.nat.output

Class RouterNatBuilder

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

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

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

    • Constructor Detail

      • RouterNatBuilder

        public RouterNatBuilder()

      • RouterNatBuilder

        public RouterNatBuilder​(NatRouterInfo arg)

      • RouterNatBuilder

        public RouterNatBuilder​(SnatState arg)

      • RouterNatBuilder

        public RouterNatBuilder​(RouterNat base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rpc.rev170209.NatRouterInfo
        • org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rpc.rev170209.DnatConfiguration
        • org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rpc.rev170209.SnatState
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getDnatIpMapping

        public java.util.List<DnatIpMapping> getDnatIpMapping()

      • getRouterName

        public java.lang.String getRouterName()

      • getRouterUuid

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterUuid()

      • getSnatIpMapping

        public java.util.List<SnatIpMapping> getSnatIpMapping()

      • augmentation

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

      • setRouterName

        public RouterNatBuilder setRouterName​(java.lang.String value)

      • setRouterUuid

        public RouterNatBuilder setRouterUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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