Class LspaBuilder

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

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

         Lspa createLspa(int fooXyzzy, int barBaz) {
             return new LspaBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • LspaBuilder

        public LspaBuilder()
      • LspaBuilder

        public LspaBuilder​(Object arg)
      • LspaBuilder

        public LspaBuilder​(Priority arg)
      • LspaBuilder

        public LspaBuilder​(Lspa 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
        • Priority
        • AttributeFilters
        • TunnelAttributes
        • Object
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getHoldPriority

        public org.opendaylight.yangtools.yang.common.Uint8 getHoldPriority()
      • getIgnore

        public Boolean getIgnore()
      • getLabelRecordingDesired

        public Boolean getLabelRecordingDesired()
      • getLocalProtectionDesired

        public Boolean getLocalProtectionDesired()
      • getProcessingRule

        public Boolean getProcessingRule()
      • getSeStyleDesired

        public Boolean getSeStyleDesired()
      • getSessionName

        public String getSessionName()
      • getSetupPriority

        public org.opendaylight.yangtools.yang.common.Uint8 getSetupPriority()
      • getTlvs

        public Tlvs getTlvs()
      • augmentation

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

        public LspaBuilder setHoldPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setLabelRecordingDesired

        public LspaBuilder setLabelRecordingDesired​(Boolean value)
      • setLocalProtectionDesired

        public LspaBuilder setLocalProtectionDesired​(Boolean value)
      • setSetupPriority

        public LspaBuilder setSetupPriority​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • addAugmentation

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

        public LspaBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lspa>> 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 Lspa build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Lspa>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Lspa,​IllegalArgumentException>