Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.prefixes.destination.ipv4

Class Ipv4PrefixesBuilder

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

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

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

    • Constructor Detail

      • Ipv4PrefixesBuilder

        public Ipv4PrefixesBuilder()

      • Ipv4PrefixesBuilder

        public Ipv4PrefixesBuilder​(PathIdGrouping arg)

      • Ipv4PrefixesBuilder

        public Ipv4PrefixesBuilder​(Ipv4Prefixes 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.params.xml.ns.yang.bgp.message.rev200120.PathIdGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Ipv4PrefixAndPathId
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getPathId

        public PathId getPathId()

      • getPrefix

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

      • augmentation

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

      • setPrefix

        public Ipv4PrefixesBuilder setPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)

      • addAugmentation

        public Ipv4PrefixesBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefixes>> augmentationType,
                                           org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefixes> augmentationValue)