Class UpdateFlowsBatchInputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<UpdateFlowsBatchInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<UpdateFlowsBatchInput,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class UpdateFlowsBatchInputBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<UpdateFlowsBatchInput>
    Class that builds UpdateFlowsBatchInputBuilder 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:

         UpdateFlowsBatchInputBuilder createTarget(int fooXyzzy, int barBaz) {
             return new UpdateFlowsBatchInputBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • UpdateFlowsBatchInputBuilder

        public UpdateFlowsBatchInputBuilder()
      • UpdateFlowsBatchInputBuilder

        public UpdateFlowsBatchInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
      • UpdateFlowsBatchInputBuilder

        public UpdateFlowsBatchInputBuilder​(BarrierSuffix arg)
    • 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
        • org.opendaylight.yang.gen.v1.urn.opendaylight.service.barrier.common.rev160315.BarrierSuffix
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getBarrierAfter

        public Boolean getBarrierAfter()
      • isBarrierAfter

        public final Boolean isBarrierAfter()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getNode

        public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowsBatchInput>> E$$ augmentation​(Class<E$$> augmentationType)
      • setBatchUpdateFlows

        public UpdateFlowsBatchInputBuilder setBatchUpdateFlows​(List<BatchUpdateFlows> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.
        values - Legacy List of values
        this builder
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry
      • setNode

        public UpdateFlowsBatchInputBuilder setNode​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
      • removeAugmentation

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