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

Class UpdatesBuilder

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

       
     Updates createUpdates(int fooXyzzy, int barBaz) {
         return new UpdatesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • UpdatesBuilder

        public UpdatesBuilder()
        Construct an empty builder.

      • UpdatesBuilder

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

      • UpdatesBuilder

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

      • UpdatesBuilder

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

      • getPath

        public Path getPath()
        Return current value associated with the property corresponding to Updates.getPath().
        Returns:
        current value

      • getSrp

        public Srp getSrp()
        Return current value associated with the property corresponding to SrpObject.getSrp().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Updates>> 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

      • setLsp

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

      • setPath

        public UpdatesBuilder setPath​(Path value)
        Set the property corresponding to Updates.getPath() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setSrp

        public UpdatesBuilder setSrp​(Srp value)
        Set the property corresponding to SrpObject.getSrp() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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