Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams

Class StreamBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Stream>, org.opendaylight.yangtools.concepts.CheckedBuilder<Stream,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class StreamBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Stream>
    Class that builds StreamBuilder 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: 

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

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

    • Constructor Detail

      • StreamBuilder

        public StreamBuilder()

      • StreamBuilder

        public StreamBuilder​(Stream base)

    • Method Detail

      • getDescription

        public String getDescription()

      • getReplayLogCreationTime

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getReplayLogCreationTime()

      • getReplaySupport

        public Boolean getReplaySupport()

      • isReplaySupport

        @Deprecated(forRemoval=true)
public final Boolean isReplaySupport()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • augmentation

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

      • setReplayLogCreationTime

        public StreamBuilder setReplayLogCreationTime​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value)

      • addAugmentation

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