Class TrunksBuilder

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

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

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

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

      • TrunksBuilder

        public TrunksBuilder()
      • TrunksBuilder

        public TrunksBuilder​(Trunks base)
    • Method Detail

      • getTrunk

        public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getTrunk()
      • augmentation

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

        public TrunksBuilder setTrunk​(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId value)
      • addAugmentation

        public TrunksBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunks>> augmentationType,
                                             org.opendaylight.yangtools.yang.binding.Augmentation<Trunks> augmentationValue)
      • removeAugmentation

        public TrunksBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunks>> augmentationType)
      • build

        public Trunks build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Trunks>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Trunks,​IllegalArgumentException>