Class RequestsBuilder

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

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

         Requests createRequests(int fooXyzzy, int barBaz) {
             return new RequestsBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

    This pattern is supported by the immutable nature of Requests, 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:
    Requests, Builder
    • 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:
        • BandwidthObject
        • OfObject
        • IncludeRouteObject
        • LspaObject
        • ExplicitRouteObject
        • ClasstypeObject
        • ReoptimizationBandwidthObject
        • ReportedRouteObject
        • EndpointsObject
        • SrpObject
        • LspObject
        • LspAttributes
        • ExcludeRouteObject
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getBandwidth

        public Bandwidth getBandwidth()
      • getClassType

        public ClassType getClassType()
      • getEro

        public Ero getEro()
      • getIro

        public Iro getIro()
      • getLsp

        public Lsp getLsp()
      • getLspa

        public Lspa getLspa()
      • getOf

        public Of getOf()
      • getRro

        public Rro getRro()
      • getSrp

        public Srp getSrp()
      • getXro

        public Xro getXro()
      • augmentation

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

        public RequestsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Requests> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

        public RequestsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Requests>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        augmentationType - augmentation type to be removed
        this builder
      • build

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