Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.netconf.config.change

Class EditBuilder

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

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

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

    • Constructor Detail

      • EditBuilder

        public EditBuilder()

      • EditBuilder

        public EditBuilder​(Edit base)

    • Method Detail

      • getOperation

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditOperationType getOperation()

      • getTarget

        public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> getTarget()

      • augmentation

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

      • setOperation

        public EditBuilder setOperation​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.EditOperationType value)

      • setTarget

        public EditBuilder setTarget​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> value)

      • addAugmentation

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