Package org.opendaylight.yang.gen.v1.urn.opendaylight.queue.service.rev150305.get.queue.output

Class PacketQueuesBuilder

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

       
     PacketQueues createPacketQueues(int fooXyzzy, int barBaz) {
         return new PacketQueuesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PacketQueuesBuilder

        public PacketQueuesBuilder()
        Construct an empty builder.

      • PacketQueuesBuilder

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

      • PacketQueuesBuilder

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

      • PacketQueuesBuilder

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

      • getPort

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

      • getProperty

        public org.opendaylight.yangtools.yang.common.Uint16 getProperty()
        Return current value associated with the property corresponding to CommonQueue.getProperty().
        Returns:
        current value

      • getQueueId

        public QueueId getQueueId()
        Return current value associated with the property corresponding to QueuePacket.getQueueId().
        Returns:
        current value

      • augmentation

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

      • setPort

        public PacketQueuesBuilder setPort​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to QueuePacket.getPort() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setProperty

        public PacketQueuesBuilder setProperty​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to CommonQueue.getProperty() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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