Class VertexBuilder


  • @Generated("mdsal-binding-generator")
    public class VertexBuilder
    extends Object
    Class that builds Vertex 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:

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

    This pattern is supported by the immutable nature of Vertex, 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 opportunities, 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:
    Vertex
    • Constructor Detail

      • VertexBuilder

        public VertexBuilder()
        Construct an empty builder.
      • VertexBuilder

        public VertexBuilder​(Vertex arg)
        Construct a new builder initialized from specified Vertex.
        Parameters:
        arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.Vertex from which the builder should be initialized
      • VertexBuilder

        public VertexBuilder​(Vertex base)
        Construct a builder initialized with state from specified Vertex.
        Parameters:
        base - Vertex from which the builder should be initialized
    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • key

        public VertexKey key()
        Return current value associated with the property corresponding to Vertex.key().
        Returns:
        current value
      • getAsn

        public org.opendaylight.yangtools.yang.common.Uint32 getAsn()
        Return current value associated with the property corresponding to Vertex.getAsn().
        Returns:
        current value
      • getName

        public String getName()
        Return current value associated with the property corresponding to Vertex.getName().
        Returns:
        current value
      • getRouterId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getRouterId()
        Return current value associated with the property corresponding to Vertex.getRouterId().
        Returns:
        current value
      • getSrgb

        public Srgb getSrgb()
        Return current value associated with the property corresponding to Vertex.getSrgb().
        Returns:
        current value
      • getVertexId

        public org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
        Return current value associated with the property corresponding to Vertex.getVertexId().
        Returns:
        current value
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vertex>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null
      • setAsn

        public VertexBuilder setAsn​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to Vertex.getAsn() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setName

        public VertexBuilder setName​(String value)
        Set the property corresponding to Vertex.getName() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setRouterId

        public VertexBuilder setRouterId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
        Set the property corresponding to Vertex.getRouterId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setSrgb

        public VertexBuilder setSrgb​(Srgb value)
        Set the property corresponding to Vertex.getSrgb() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setVertexId

        public VertexBuilder setVertexId​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to Vertex.getVertexId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • addAugmentation

        public VertexBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Vertex> 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 VertexBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vertex>> 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 @NonNull Vertex build()
        A new Vertex instance.
        Returns:
        A new Vertex instance.