Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.as._4.spec.common

Class As4SpecificCommonBuilder

  • @Generated("mdsal-binding-generator")
public class As4SpecificCommonBuilder
extends Object
    Class that builds As4SpecificCommon 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: 

       
     As4SpecificCommon createAs4SpecificCommon(int fooXyzzy, int barBaz) {
         return new As4SpecificCommonBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • As4SpecificCommonBuilder

        public As4SpecificCommonBuilder()
        Construct an empty builder.

      • As4SpecificCommonBuilder

        public As4SpecificCommonBuilder​(As4SpecificCommon base)
        Construct a builder initialized with state from specified As4SpecificCommon.
        Parameters:
        base - As4SpecificCommon from which the builder should be initialized

    • Method Detail

      • getAsNumber

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAsNumber()
        Return current value associated with the property corresponding to As4SpecificCommon.getAsNumber().
        Returns:
        current value

      • getLocalAdministrator

        public org.opendaylight.yangtools.yang.common.Uint16 getLocalAdministrator()
        Return current value associated with the property corresponding to As4SpecificCommon.getLocalAdministrator().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<As4SpecificCommon>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setAsNumber

        public As4SpecificCommonBuilder setAsNumber​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
        Set the property corresponding to As4SpecificCommon.getAsNumber() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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