Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.ip.prefix.map.ip.prefix.info

Class RoutePathsBuilder

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

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

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

    • Constructor Detail

      • RoutePathsBuilder

        public RoutePathsBuilder()

      • RoutePathsBuilder

        public RoutePathsBuilder​(RoutePaths base)

    • Method Detail

      • getGatewayMacAddress

        public java.lang.String getGatewayMacAddress()

      • getLabel

        public org.opendaylight.yangtools.yang.common.Uint32 getLabel()

      • getNexthopAddress

        public java.lang.String getNexthopAddress()

      • augmentation

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

      • setGatewayMacAddress

        public RoutePathsBuilder setGatewayMacAddress​(java.lang.String value)

      • setLabel

        public RoutePathsBuilder setLabel​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setLabel

        @Deprecated(forRemoval=true)
public RoutePathsBuilder setLabel​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setLabel(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNexthopAddress

        public RoutePathsBuilder setNexthopAddress​(java.lang.String value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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