Class FlowspecRouteBuilder

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

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

         FlowspecRoute createFlowspecRoute(int fooXyzzy, int barBaz) {
             return new FlowspecRouteBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • FlowspecRouteBuilder

        public FlowspecRouteBuilder()
      • FlowspecRouteBuilder

        public FlowspecRouteBuilder​(BgpRibRoute arg)
      • FlowspecRouteBuilder

        public FlowspecRouteBuilder​(Route arg)
      • FlowspecRouteBuilder

        public FlowspecRouteBuilder​(PathIdGrouping arg)
      • FlowspecRouteBuilder

        public FlowspecRouteBuilder​(PathAttributes arg)
      • FlowspecRouteBuilder

        public FlowspecRouteBuilder​(FlowspecRoute 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:
        • FlowspecIpv4RouteList
        • PathAttributes
        • PathIdGrouping
        • Route
        • FlowspecDestination
        • BgpRibRoute
        • FlowspecDestinationGroupIpv4
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getAttributes

        public Attributes getAttributes()
      • getPathId

        public PathId getPathId()
      • getRouteKey

        public String getRouteKey()
      • augmentation

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

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

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