Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces.state._interface

Class VhostUserBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<VhostUser>, org.opendaylight.yangtools.concepts.CheckedBuilder<VhostUser,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class VhostUserBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<VhostUser>
    Class that builds VhostUserBuilder 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: 

       
     VhostUserBuilder createTarget(int fooXyzzy, int barBaz) {
         return new VhostUserBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • 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.params.xml.ns.yang.v3po.rev170607.VhostUserInterfaceStateAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VhostUserInterfaceBaseAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.InterfaceTag
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getConnectError

        public java.lang.String getConnectError()

      • getFeatures

        public org.opendaylight.yangtools.yang.common.Uint64 getFeatures()

      • getNumMemoryRegions

        public org.opendaylight.yangtools.yang.common.Uint32 getNumMemoryRegions()

      • getSocket

        public java.lang.String getSocket()

      • getTag

        public java.lang.String getTag()

      • getVirtioNetHdrSize

        public org.opendaylight.yangtools.yang.common.Uint32 getVirtioNetHdrSize()

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VhostUser>> E$$ augmentation​(java.lang.Class<E$$> augmentationType)

      • setConnectError

        public VhostUserBuilder setConnectError​(java.lang.String value)

      • setFeatures

        public VhostUserBuilder setFeatures​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setFeatures

        @Deprecated(forRemoval=true)
public VhostUserBuilder setFeatures​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setFeatures(Uint64) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setNumMemoryRegions

        public VhostUserBuilder setNumMemoryRegions​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setNumMemoryRegions

        @Deprecated(forRemoval=true)
public VhostUserBuilder setNumMemoryRegions​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setNumMemoryRegions(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setVirtioNetHdrSize

        public VhostUserBuilder setVirtioNetHdrSize​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setVirtioNetHdrSize

        @Deprecated(forRemoval=true)
public VhostUserBuilder setVirtioNetHdrSize​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setVirtioNetHdrSize(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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

      • build

        public VhostUser build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<VhostUser>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<VhostUser,​java.lang.IllegalArgumentException>