Class SourcePortsBuilder

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

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

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

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

      • SourcePortsBuilder

        public SourcePortsBuilder()
      • SourcePortsBuilder

        public SourcePortsBuilder​(SourcePorts 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.bgp.flowspec.rev200120.NumericTwoByteValue
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types
      • getValue

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

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

        public SourcePortsBuilder setValue​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setValue

        @Deprecated(forRemoval=true)
        public SourcePortsBuilder setValue​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setValue(Uint16)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • addAugmentation

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

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