Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.topology.stats.rpc.rev190321.get.stats.input

Class TopologyBuilder

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

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

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

    • Constructor Detail

      • TopologyBuilder

        public TopologyBuilder()

      • TopologyBuilder

        public TopologyBuilder​(Topology base)

    • Method Detail

      • getTopologyId

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId getTopologyId()

      • augmentation

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

      • setNode

        @Deprecated(forRemoval=true)
public TopologyBuilder setNode​(List<Node> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link #setNode(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

      • setTopologyId

        public TopologyBuilder setTopologyId​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId value)

      • addAugmentation

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