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

Class LspBuilder

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

       
     Lsp createLsp(int fooXyzzy, int barBaz) {
         return new LspBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • LspBuilder

        public LspBuilder()
        Construct an empty builder.

      • LspBuilder

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

      • LspBuilder

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

      • LspBuilder

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

      • getAdministrative

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

      • getDelegate

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

      • getIgnore

        public Boolean getIgnore()
        Return current value associated with the property corresponding to ObjectHeader.getIgnore().
        Returns:
        current value

      • getPlspId

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

      • getRemove

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

      • getSync

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

      • getTlvs

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

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setAdministrative

        public LspBuilder setAdministrative​(Boolean value)
        Set the property corresponding to Lsp.getAdministrative() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setDelegate

        public LspBuilder setDelegate​(Boolean value)
        Set the property corresponding to Lsp.getDelegate() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPlspId

        public LspBuilder setPlspId​(PlspId value)
        Set the property corresponding to Lsp.getPlspId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setRemove

        public LspBuilder setRemove​(Boolean value)
        Set the property corresponding to Lsp.getRemove() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setSync

        public LspBuilder setSync​(Boolean value)
        Set the property corresponding to Lsp.getSync() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTlvs

        public LspBuilder setTlvs​(Tlvs value)
        Set the property corresponding to Lsp.getTlvs() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public LspBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Lsp> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • removeAugmentation

        public LspBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder

      • build

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