Class LacpAutoGeneratedBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<LacpAutoGenerated>, org.opendaylight.yangtools.concepts.CheckedBuilder<LacpAutoGenerated,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class LacpAutoGeneratedBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<LacpAutoGenerated>
    Class that builds LacpAutoGenerated 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:

         LacpAutoGenerated createLacpAutoGenerated(int fooXyzzy, int barBaz) {
             return new LacpAutoGeneratedBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • LacpAutoGeneratedBuilder

        public LacpAutoGeneratedBuilder()
      • LacpAutoGeneratedBuilder

        public LacpAutoGeneratedBuilder​(LacpAutoGenerated base)
    • Method Detail

      • getCeLacpMacAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getCeLacpMacAddress()
      • getCeLacpPortKey

        public org.opendaylight.yangtools.yang.common.Uint16 getCeLacpPortKey()
      • augmentation

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

        public LacpAutoGeneratedBuilder setCeLacpMacAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      • setCeLacpPortKey

        public LacpAutoGeneratedBuilder setCeLacpPortKey​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • addAugmentation

        public LacpAutoGeneratedBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

        public LacpAutoGeneratedBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        augmentationType - augmentation type to be removed
        this builder