Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object

Class RpBuilder

  • @Generated("mdsal-binding-generator")
public class RpBuilder
extends Object
    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

    • Constructor Detail

      • RpBuilder

        public RpBuilder()
        Construct an empty builder.

      • RpBuilder

        public RpBuilder​(Object arg)
        Construct a new builder initialized from specified Object.
        Parameters:
        arg - Object from which the builder should be initialized

      • RpBuilder

        public RpBuilder​(ObjectHeader arg)
        Construct a new builder initialized from specified ObjectHeader.
        Parameters:
        arg - ObjectHeader from which the builder should be initialized

      • RpBuilder

        public RpBuilder​(Rp base)
        Construct a builder initialized with state from specified Rp.
        Parameters:
        base - Rp from which the builder should be initialized

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBiDirectional

        public Boolean getBiDirectional()
        Return current value associated with the property corresponding to Rp.getBiDirectional().
        Returns:
        current value

      • getEroCompression

        public Boolean getEroCompression()
        Return current value associated with the property corresponding to Rp.getEroCompression().
        Returns:
        current value

      • getFragmentation

        public Boolean getFragmentation()
        Return current value associated with the property corresponding to Rp.getFragmentation().
        Returns:
        current value

      • getIgnore

        public Boolean getIgnore()
        Return current value associated with the property corresponding to ObjectHeader.getIgnore().
        Returns:
        current value

      • getLoose

        public Boolean getLoose()
        Return current value associated with the property corresponding to Rp.getLoose().
        Returns:
        current value

      • getMakeBeforeBreak

        public Boolean getMakeBeforeBreak()
        Return current value associated with the property corresponding to Rp.getMakeBeforeBreak().
        Returns:
        current value

      • getOrder

        public Boolean getOrder()
        Return current value associated with the property corresponding to Rp.getOrder().
        Returns:
        current value

      • getP2mp

        public Boolean getP2mp()
        Return current value associated with the property corresponding to Rp.getP2mp().
        Returns:
        current value

      • getPathKey

        public Boolean getPathKey()
        Return current value associated with the property corresponding to Rp.getPathKey().
        Returns:
        current value

      • getPriority

        public org.opendaylight.yangtools.yang.common.Uint8 getPriority()
        Return current value associated with the property corresponding to Rp.getPriority().
        Returns:
        current value

      • getReoptimization

        public Boolean getReoptimization()
        Return current value associated with the property corresponding to Rp.getReoptimization().
        Returns:
        current value

      • getRequestId

        public RequestId getRequestId()
        Return current value associated with the property corresponding to Rp.getRequestId().
        Returns:
        current value

      • getSupplyOf

        public Boolean getSupplyOf()
        Return current value associated with the property corresponding to Rp.getSupplyOf().
        Returns:
        current value

      • getTlvs

        public Tlvs getTlvs()
        Return current value associated with the property corresponding to Rp.getTlvs().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rp>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setBiDirectional

        public RpBuilder setBiDirectional​(Boolean value)
        Set the property corresponding to Rp.getBiDirectional() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setEroCompression

        public RpBuilder setEroCompression​(Boolean value)
        Set the property corresponding to Rp.getEroCompression() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setFragmentation

        public RpBuilder setFragmentation​(Boolean value)
        Set the property corresponding to Rp.getFragmentation() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setLoose

        public RpBuilder setLoose​(Boolean value)
        Set the property corresponding to Rp.getLoose() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMakeBeforeBreak

        public RpBuilder setMakeBeforeBreak​(Boolean value)
        Set the property corresponding to Rp.getMakeBeforeBreak() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setOrder

        public RpBuilder setOrder​(Boolean value)
        Set the property corresponding to Rp.getOrder() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setP2mp

        public RpBuilder setP2mp​(Boolean value)
        Set the property corresponding to Rp.getP2mp() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPathKey

        public RpBuilder setPathKey​(Boolean value)
        Set the property corresponding to Rp.getPathKey() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPriority

        public RpBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to Rp.getPriority() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setReoptimization

        public RpBuilder setReoptimization​(Boolean value)
        Set the property corresponding to Rp.getReoptimization() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setRequestId

        public RpBuilder setRequestId​(RequestId value)
        Set the property corresponding to Rp.getRequestId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setSupplyOf

        public RpBuilder setSupplyOf​(Boolean value)
        Set the property corresponding to Rp.getSupplyOf() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTlvs

        public RpBuilder setTlvs​(Tlvs value)
        Set the property corresponding to Rp.getTlvs() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • 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 @NonNull Rp build()
        A new Rp instance.
        Returns:
        A new Rp instance.