Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.entity

Class CandidateBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Candidate>, org.opendaylight.yangtools.concepts.CheckedBuilder<Candidate,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class CandidateBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Candidate>
    Class that builds CandidateBuilder 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: 

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

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

    • Constructor Detail

      • CandidateBuilder

        public CandidateBuilder()

      • CandidateBuilder

        public CandidateBuilder​(Candidate base)

    • Method Detail

      • getName

        public String getName()

      • augmentation

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

      • addAugmentation

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

      • addAugmentation

        @Deprecated(forRemoval=true)
public CandidateBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Candidate>> augmentationType,
                                        org.opendaylight.yangtools.yang.binding.Augmentation<Candidate> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

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