Class UpdateKeyInputBuilder

  • @Generated("mdsal-binding-generator")
    public class UpdateKeyInputBuilder
    extends java.lang.Object
    Class that builds UpdateKeyInput 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:

         UpdateKeyInput createUpdateKeyInput(int fooXyzzy, int barBaz) {
             return new UpdateKeyInputBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • UpdateKeyInputBuilder

        public UpdateKeyInputBuilder()
        Construct an empty builder.
      • UpdateKeyInputBuilder

        public UpdateKeyInputBuilder​(EidContainer arg)
        Construct a new builder initialized from specified EidContainer.
        arg - EidContainer from which the builder should be initialized
      • UpdateKeyInputBuilder

        public UpdateKeyInputBuilder​(MappingAuthkeyContainer arg)
        Construct a new builder initialized from specified MappingAuthkeyContainer.
        arg - MappingAuthkeyContainer from which the builder should be initialized
      • UpdateKeyInputBuilder

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

        public Eid getEid()
        Return current value associated with the property corresponding to EidContainer.getEid().
        current value
      • augmentation

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

        public UpdateKeyInputBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateKeyInput> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        java.lang.NullPointerException - if augmentation is null
      • removeAugmentation

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