Class RpBuilder

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

    @Generated("mdsal-binding-generator")
    public class RpBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<Rp>
    Class that builds Rp 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:

       
         Rp createRp(int fooXyzzy, int barBaz) {
             return new RpBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • RpBuilder

        public RpBuilder()
      • RpBuilder

        public RpBuilder​(Object arg)
      • RpBuilder

        public RpBuilder​(Rp 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:
        • ObjectHeader
        • Object
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getBiDirectional

        public Boolean getBiDirectional()
      • getEroCompression

        public Boolean getEroCompression()
      • getFragmentation

        public Boolean getFragmentation()
      • getIgnore

        public Boolean getIgnore()
      • getLoose

        public Boolean getLoose()
      • getMakeBeforeBreak

        public Boolean getMakeBeforeBreak()
      • getOrder

        public Boolean getOrder()
      • getP2mp

        public Boolean getP2mp()
      • getPathKey

        public Boolean getPathKey()
      • getPriority

        public org.opendaylight.yangtools.yang.common.Uint8 getPriority()
      • getProcessingRule

        public Boolean getProcessingRule()
      • getReoptimization

        public Boolean getReoptimization()
      • getRequestId

        public RequestId getRequestId()
      • getSupplyOf

        public Boolean getSupplyOf()
      • getTlvs

        public Tlvs getTlvs()
      • augmentation

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

        public RpBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • addAugmentation

        public RpBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Rp> 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 RpBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rp>> 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
      • build

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