Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.config.rev181109

Class PcepTunnelTopologyConfigBuilder

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

       
     PcepTunnelTopologyConfig createPcepTunnelTopologyConfig(int fooXyzzy, int barBaz) {
         return new PcepTunnelTopologyConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PcepTunnelTopologyConfigBuilder

        public PcepTunnelTopologyConfigBuilder()
        Construct an empty builder.

      • PcepTunnelTopologyConfigBuilder

        public PcepTunnelTopologyConfigBuilder​(TopologyRef arg)
        Construct a new builder initialized from specified TopologyRef.
        Parameters:
        arg - TopologyRef from which the builder should be initialized

      • PcepTunnelTopologyConfigBuilder

        public PcepTunnelTopologyConfigBuilder​(PcepTunnelTopologyConfig base)
        Construct a builder initialized with state from specified PcepTunnelTopologyConfig.
        Parameters:
        base - PcepTunnelTopologyConfig 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getPcepTopologyReference

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId getPcepTopologyReference()
        Return current value associated with the property corresponding to TopologyRef.getPcepTopologyReference().
        Returns:
        current value

      • setPcepTopologyReference

        public PcepTunnelTopologyConfigBuilder setPcepTopologyReference​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId value)
        Set the property corresponding to TopologyRef.getPcepTopologyReference() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder