Class FlowspecL3vpnRouteBuilder

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

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

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

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

      • FlowspecL3vpnRouteBuilder

        public FlowspecL3vpnRouteBuilder()
      • FlowspecL3vpnRouteBuilder

        public FlowspecL3vpnRouteBuilder​(BgpRibRoute arg)
      • FlowspecL3vpnRouteBuilder

        public FlowspecL3vpnRouteBuilder​(Route arg)
      • FlowspecL3vpnRouteBuilder

        public FlowspecL3vpnRouteBuilder​(PathIdGrouping arg)
      • FlowspecL3vpnRouteBuilder

        public FlowspecL3vpnRouteBuilder​(PathAttributes arg)
      • FlowspecL3vpnRouteBuilder

        public FlowspecL3vpnRouteBuilder​(FlowspecL3vpnRoute 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.PathAttributes
        • 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.flowspec.rev200120.FlowspecIpv6RouteList
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.FlowspecDestination
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.BgpRibRoute
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.FlowspecDestinationGroupIpv6
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteDistinguisherGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types
      • getAttributes

        public Attributes getAttributes()
      • getPathId

        public PathId getPathId()
      • getRouteKey

        public String getRouteKey()
      • augmentation

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