Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720

Class Path1Builder

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

       
     Path1 createPath1(int fooXyzzy, int barBaz) {
         return new Path1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • Path1Builder

        public Path1Builder()
        Construct an empty builder.

      • Path1Builder

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

      • Path1Builder

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

      • Path1Builder

        public Path1Builder​(Path1 base)
        Construct a builder initialized with state from specified Path1.
        Parameters:
        base - Path1 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

      • getLsp

        public Lsp getLsp()
        Return current value associated with the property corresponding to LspObject.getLsp().
        Returns:
        current value

      • setLsp

        public Path1Builder setLsp​(Lsp value)
        Set the property corresponding to LspObject.getLsp() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • build

        public @NonNull Path1 build()
        A new Path1 instance.
        Returns:
        A new Path1 instance.