Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list

Class EidItemBuilder

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

       
     EidItem createEidItem(int fooXyzzy, int barBaz) {
         return new EidItemBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • EidItemBuilder

        public EidItemBuilder()
        Construct an empty builder.

      • EidItemBuilder

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

      • EidItemBuilder

        public EidItemBuilder​(EidItem base)
        Construct a builder initialized with state from specified EidItem.
        Parameters:
        base - EidItem 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:
        java.lang.IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • key

        public EidItemKey key()
        Return current value associated with the property corresponding to EidItem.key().
        Returns:
        current value

      • getEid

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

      • getEidItemId

        public java.lang.String getEidItemId()
        Return current value associated with the property corresponding to EidItem.getEidItemId().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EidItem>> E$$ augmentation​(java.lang.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:
        java.lang.NullPointerException - if augmentType is null

      • setEid

        public EidItemBuilder setEid​(Eid value)
        Set the property corresponding to EidContainer.getEid() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setEidItemId

        public EidItemBuilder setEidItemId​(java.lang.String value)
        Set the property corresponding to EidItem.getEidItemId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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

      • removeAugmentation

        public EidItemBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidItem>> 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