Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute

Class SrAdjIdsBuilder

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

       
     SrAdjIds createSrAdjIds(int fooXyzzy, int barBaz) {
         return new SrAdjIdsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • SrAdjIdsBuilder

        public SrAdjIdsBuilder()
        Construct an empty builder.

      • SrAdjIdsBuilder

        public SrAdjIdsBuilder​(AdjSidTlv arg)
        Construct a new builder initialized from specified AdjSidTlv.
        Parameters:
        arg - AdjSidTlv from which the builder should be initialized

      • SrAdjIdsBuilder

        public SrAdjIdsBuilder​(AdjFlags arg)
        Construct a new builder initialized from specified AdjFlags.
        Parameters:
        arg - AdjFlags from which the builder should be initialized

      • SrAdjIdsBuilder

        public SrAdjIdsBuilder​(EpeAdjSidTlv arg)
        Construct a new builder initialized from specified EpeAdjSidTlv.
        Parameters:
        arg - EpeAdjSidTlv from which the builder should be initialized

      • SrAdjIdsBuilder

        public SrAdjIdsBuilder​(SidLabelIndex arg)
        Construct a new builder initialized from specified SidLabelIndex.
        Parameters:
        arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.SidLabelIndex from which the builder should be initialized

      • SrAdjIdsBuilder

        public SrAdjIdsBuilder​(SrAdjIds base)
        Construct a builder initialized with state from specified SrAdjIds.
        Parameters:
        base - SrAdjIds 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

      • getFlags

        public Flags getFlags()
        Return current value associated with the property corresponding to AdjFlags.getFlags().
        Returns:
        current value

      • getWeight

        public Weight getWeight()
        Return current value associated with the property corresponding to EpeAdjSidTlv.getWeight().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrAdjIds>> 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

      • setFlags

        public SrAdjIdsBuilder setFlags​(Flags value)
        Set the property corresponding to AdjFlags.getFlags() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public SrAdjIdsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<SrAdjIds> 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 SrAdjIdsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrAdjIds>> 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