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

Class VertexBuilder

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

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

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

    • Constructor Detail

      • VertexBuilder

        public VertexBuilder()

      • VertexBuilder

        public VertexBuilder​(Vertex arg)

      • VertexBuilder

        public VertexBuilder​(Vertex 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.Vertex
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getAsn

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

      • getName

        public String getName()

      • getRouterId

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

      • getSrgb

        public Srgb getSrgb()

      • getVertexId

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

      • augmentation

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

      • setAsn

        public VertexBuilder setAsn​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setAsn

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

      • setRouterId

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

      • setVertexId

        public VertexBuilder setVertexId​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setVertexId

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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