Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.bridge.domains

Class BridgeDomainBuilder

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

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

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

    • Constructor Detail

      • BridgeDomainBuilder

        public BridgeDomainBuilder()

      • BridgeDomainBuilder

        public BridgeDomainBuilder​(BridgeDomain 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.v3po.rev170607.BridgeDomainAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.L2FibAttributes
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getL2FibTable

        public L2FibTable getL2FibTable()

      • getName

        public java.lang.String getName()

      • isArpTermination

        public java.lang.Boolean isArpTermination()

      • isFlood

        public java.lang.Boolean isFlood()

      • isForward

        public java.lang.Boolean isForward()

      • isLearn

        public java.lang.Boolean isLearn()

      • isUnknownUnicastFlood

        public java.lang.Boolean isUnknownUnicastFlood()

      • augmentation

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

      • setArpTermination

        public BridgeDomainBuilder setArpTermination​(java.lang.Boolean value)

      • setUnknownUnicastFlood

        public BridgeDomainBuilder setUnknownUnicastFlood​(java.lang.Boolean value)

      • addAugmentation

        public BridgeDomainBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain> 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

      • addAugmentation

        @Deprecated(forRemoval=true)
public BridgeDomainBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain>> augmentationType,
                                           org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain> 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 BridgeDomainBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain>> 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 BridgeDomain build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<BridgeDomain>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<BridgeDomain,​java.lang.IllegalArgumentException>