Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.listener.rev150825.listener.test

Class ListItemBuilder

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

       
     ListItem createListItem(int fooXyzzy, int barBaz) {
         return new ListItemBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • ListItemBuilder

        public ListItemBuilder()
        Construct an empty builder.

      • ListItemBuilder

        public ListItemBuilder​(ListItem base)
        Construct a builder initialized with state from specified ListItem.
        Parameters:
        base - ListItem from which the builder should be initialized

    • Method Detail

      • key

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

      • getOp

        public org.opendaylight.yangtools.yang.common.Uint32 getOp()
        Return current value associated with the property corresponding to ListItem.getOp().
        Returns:
        current value

      • getSip

        public String getSip()
        Return current value associated with the property corresponding to ListItem.getSip().
        Returns:
        current value

      • augmentation

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

      • setOp

        public ListItemBuilder setOp​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to ListItem.getOp() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setSip

        public ListItemBuilder setSip​(String value)
        Set the property corresponding to ListItem.getSip() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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