Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.overload.object

Class OverloadBuilder

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

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

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

    • Constructor Detail

      • OverloadBuilder

        public OverloadBuilder()

      • OverloadBuilder

        public OverloadBuilder​(Object arg)

      • OverloadBuilder

        public OverloadBuilder​(ObjectHeader arg)

      • OverloadBuilder

        public OverloadBuilder​(Overload base)

    • 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getDuration

        public org.opendaylight.yangtools.yang.common.Uint16 getDuration()

      • getIgnore

        public Boolean getIgnore()

      • isIgnore

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

      • getProcessingRule

        public Boolean getProcessingRule()

      • isProcessingRule

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

      • augmentation

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

      • setDuration

        public OverloadBuilder setDuration​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setDuration

        @Deprecated(forRemoval=true)
public OverloadBuilder setDuration​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setDuration(Uint16) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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