Class MirrorsBuilder


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

       
         Mirrors createMirrors(int fooXyzzy, int barBaz) {
             return new MirrorsBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • MirrorsBuilder

        public MirrorsBuilder()
        Construct an empty builder.
      • MirrorsBuilder

        public MirrorsBuilder​(Timestamp arg)
        Construct a new builder initialized from specified Timestamp.
        Parameters:
        arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Timestamp from which the builder should be initialized
      • MirrorsBuilder

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

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampMicro()
        Return current value associated with the property corresponding to Timestamp.getTimestampMicro().
        Returns:
        current value
      • getTimestampSec

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampSec()
        Return current value associated with the property corresponding to Timestamp.getTimestampSec().
        Returns:
        current value
      • augmentation

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

        public MirrorsBuilder setTimestampMicro​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
        Set the property corresponding to Timestamp.getTimestampMicro() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setTimestampSec

        public MirrorsBuilder setTimestampSec​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
        Set the property corresponding to Timestamp.getTimestampSec() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • addAugmentation

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