Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers

Class RouterBuilder

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

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

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

    • Constructor Detail

      • RouterBuilder

        public RouterBuilder()

      • RouterBuilder

        public RouterBuilder​(Router 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.l3.rev150712.L3Attributes
        • 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 or has property with incompatible value

      • getAdminStateUp

        public Boolean getAdminStateUp()

      • isAdminStateUp

        @Deprecated(forRemoval=true)
public final Boolean isAdminStateUp()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getDistributed

        public Boolean getDistributed()

      • isDistributed

        @Deprecated(forRemoval=true)
public final Boolean isDistributed()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getGatewayPortId

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

      • getName

        public String getName()

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getRouterStatus

        public String getRouterStatus()

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

      • augmentation

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

      • setGatewayPortId

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

      • setRoutes

        @Deprecated(forRemoval=true)
public RouterBuilder setRoutes​(List<Routes> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setRoutes(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

      • setTenantId

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

      • setUuid

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

      • addAugmentation

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