Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance

Class Ipv4FamilyBuilder

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

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

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

    • Constructor Detail

      • Ipv4FamilyBuilder

        public Ipv4FamilyBuilder()

      • Ipv4FamilyBuilder

        public Ipv4FamilyBuilder​(VpnAfConfig arg)

      • Ipv4FamilyBuilder

        public Ipv4FamilyBuilder​(Ipv4Family 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.neutronvpn.l3vpn.rev200204.VpnAfConfig
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getApplyLabel

        public ApplyLabel getApplyLabel()

      • getExportRoutePolicy

        public java.lang.String getExportRoutePolicy()

      • getImportRibs

        public ImportRibs getImportRibs()

      • getImportRoutePolicy

        public java.lang.String getImportRoutePolicy()

      • getRouteDistinguisher

        public java.util.List<java.lang.String> getRouteDistinguisher()

      • getTunnelPolicy

        public java.lang.String getTunnelPolicy()

      • getVpnTargets

        public VpnTargets getVpnTargets()

      • isTrafficStatistics

        public java.lang.Boolean isTrafficStatistics()

      • isVpnFrr

        public java.lang.Boolean isVpnFrr()

      • augmentation

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

      • setExportRoutePolicy

        public Ipv4FamilyBuilder setExportRoutePolicy​(java.lang.String value)

      • setImportRoutePolicy

        public Ipv4FamilyBuilder setImportRoutePolicy​(java.lang.String value)

      • setRouteDistinguisher

        public Ipv4FamilyBuilder setRouteDistinguisher​(java.util.List<java.lang.String> values)

      • setTunnelPolicy

        public Ipv4FamilyBuilder setTunnelPolicy​(java.lang.String value)

      • setTrafficStatistics

        public Ipv4FamilyBuilder setTrafficStatistics​(java.lang.Boolean value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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