Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.rpki.config

Class BestpathComputationBuilder

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

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

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

    • Constructor Detail

      • BestpathComputationBuilder

        public BestpathComputationBuilder()

    • Method Detail

      • getAllowInvalid

        public java.lang.Boolean getAllowInvalid()

      • isAllowInvalid

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

      • getEnable

        public java.lang.Boolean getEnable()

      • isEnable

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

      • augmentation

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

      • addAugmentation

        public BestpathComputationBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<BestpathComputation> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null

      • removeAugmentation

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