Class Ipv4PrefixesBuilder

  • @Generated("mdsal-binding-generator")
    public class Ipv4PrefixesBuilder
    extends Object
    Class that builds Ipv4Prefixes 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:

         Ipv4Prefixes createIpv4Prefixes(int fooXyzzy, int barBaz) {
             return new Ipv4PrefixesBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • Ipv4PrefixesBuilder

        public Ipv4PrefixesBuilder()
        Construct an empty builder.
      • Ipv4PrefixesBuilder

        public Ipv4PrefixesBuilder​(Ipv4PrefixAndPathId arg)
        Construct a new builder initialized from specified Ipv4PrefixAndPathId.
        arg - Ipv4PrefixAndPathId from which the builder should be initialized
      • Ipv4PrefixesBuilder

        public Ipv4PrefixesBuilder​(PathIdGrouping arg)
        Construct a new builder initialized from specified PathIdGrouping.
        arg - PathIdGrouping from which the builder should be initialized
      • Ipv4PrefixesBuilder

        public Ipv4PrefixesBuilder​(Ipv4Prefixes base)
        Construct a builder initialized with state from specified Ipv4Prefixes.
        base - Ipv4Prefixes from which the builder should be initialized
    • 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:
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getPrefix

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getPrefix()
        Return current value associated with the property corresponding to Ipv4PrefixAndPathId.getPrefix().
        current value
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefixes>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        augmentationType - augmentation type class
        Augmentation object from this builder, or null if not present
        NullPointerException - if augmentType is null
      • setPrefix

        public Ipv4PrefixesBuilder setPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
        Set the property corresponding to Ipv4PrefixAndPathId.getPrefix() to the specified value.
        value - desired value
        this builder
      • addAugmentation

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

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