Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools.pool.members

Class MemberBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Member>, org.opendaylight.yangtools.concepts.CheckedBuilder<Member,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class MemberBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Member>
    Class that builds MemberBuilder 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: 

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

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

    • Constructor Detail

      • MemberBuilder

        public MemberBuilder()

      • MemberBuilder

        public MemberBuilder​(Member base)

    • 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.neutron.lbaasv2.rev150712.MemberAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAddress()

      • getProjectId

        public String getProjectId()

      • getProtocolPort

        public org.opendaylight.yangtools.yang.common.Uint16 getProtocolPort()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getSubnetId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSubnetId()

      • getTenantId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()

      • getUuid

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()

      • getWeight

        public org.opendaylight.yangtools.yang.common.Uint16 getWeight()

      • isAdminStateUp

        public Boolean isAdminStateUp()

      • augmentation

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

      • setAddress

        public MemberBuilder setAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setProtocolPort

        public MemberBuilder setProtocolPort​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setProtocolPort

        @Deprecated(forRemoval=true)
public MemberBuilder setProtocolPort​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setProtocolPort(Uint16) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setSubnetId

        public MemberBuilder setSubnetId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setTenantId

        public MemberBuilder setTenantId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setUuid

        public MemberBuilder setUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setWeight

        public MemberBuilder setWeight​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setWeight

        @Deprecated(forRemoval=true)
public MemberBuilder setWeight​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setWeight(Uint16) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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

      • addAugmentation

        @Deprecated(forRemoval=true)
public MemberBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Member>> augmentationType,
                                     org.opendaylight.yangtools.yang.binding.Augmentation<Member> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

        public MemberBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Member>> 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 Member build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Member>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Member,​IllegalArgumentException>