Class VpnIpv4RoutesCaseBuilder

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

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

         VpnIpv4RoutesCase createVpnIpv4RoutesCase(int fooXyzzy, int barBaz) {
             return new VpnIpv4RoutesCaseBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • VpnIpv4RoutesCaseBuilder

        public VpnIpv4RoutesCaseBuilder()
      • VpnIpv4RoutesCaseBuilder

        public VpnIpv4RoutesCaseBuilder​(L3vpnIpv4Routes arg)
      • VpnIpv4RoutesCaseBuilder

        public VpnIpv4RoutesCaseBuilder​(VpnIpv4RoutesCase 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:
        • L3vpnIpv4Routes
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • augmentation

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

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

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