Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports

Class PortBuilder

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

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

    This pattern is supported by the immutable nature of PortBuilder, 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:
    PortBuilder, 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.neutron.ports.rev150712.PortAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.AdminAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getDeviceId

        public String getDeviceId()

      • getDeviceOwner

        public String getDeviceOwner()

      • getMacAddress

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

      • getName

        public String getName()

      • getNetworkId

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

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getSecurityGroups

        public List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getSecurityGroups()

      • getStatus

        public String getStatus()

      • 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()

      • isAdminStateUp

        public Boolean isAdminStateUp()

      • augmentation

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

      • setAllowedAddressPairs

        @Deprecated(forRemoval=true)
public PortBuilder setAllowedAddressPairs​(List<AllowedAddressPairs> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setAllowedAddressPairs(Map) instead.
        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.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry

      • setExtraDhcpOpts

        @Deprecated(forRemoval=true)
public PortBuilder setExtraDhcpOpts​(List<ExtraDhcpOpts> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setExtraDhcpOpts(Map) instead.
        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.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry

      • setFixedIps

        @Deprecated(forRemoval=true)
public PortBuilder setFixedIps​(List<FixedIps> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setFixedIps(Map) instead.
        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.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry

      • setMacAddress

        public PortBuilder setMacAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)

      • setNetworkId

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

      • setSecurityGroups

        public PortBuilder setSecurityGroups​(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)

      • setTenantId

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

      • setUuid

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

      • addAugmentation

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