Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.graph.topology.graph

Class EdgeBuilder

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

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

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

    • Constructor Detail

      • EdgeBuilder

        public EdgeBuilder()

      • EdgeBuilder

        public EdgeBuilder​(Edge arg)

      • EdgeBuilder

        public EdgeBuilder​(Edge 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.params.xml.ns.yang.graph.rev191125.Edge
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getEdgeId

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

      • getLocalVertexId

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

      • getName

        public String getName()

      • getRemoteVertexId

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

      • augmentation

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

      • setEdgeId

        public EdgeBuilder setEdgeId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setEdgeId

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

      • setLocalVertexId

        public EdgeBuilder setLocalVertexId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setLocalVertexId

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

      • setRemoteVertexId

        public EdgeBuilder setRemoteVertexId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setRemoteVertexId

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

      • addAugmentation

        public EdgeBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Edge>> augmentationType,
                                   org.opendaylight.yangtools.yang.binding.Augmentation<Edge> augmentationValue)

      • removeAugmentation

        public EdgeBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Edge>> augmentationType)

      • build

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