Class UnnumberedBuilder

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

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

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

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

      • UnnumberedBuilder

        public UnnumberedBuilder()
      • UnnumberedBuilder

        public UnnumberedBuilder​(InterfaceRef arg)
      • UnnumberedBuilder

        public UnnumberedBuilder​(Unnumbered 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.http.openconfig.net.yang.interfaces.rev160412.InterfaceRef
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types
      • getConfig

        public Config getConfig()
      • getState

        public State getState()
      • augmentation

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

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

        public UnnumberedBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Unnumbered>> augmentationType)