Class BgpBuilder

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

    public class BgpBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<Bgp>
    Class that builds BgpBuilder 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:

         BgpBuilder createTarget(int fooXyzzy, int barBaz) {
             return new BgpBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

    This pattern is supported by the immutable nature of BgpBuilder, 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:
    BgpBuilder, 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:
        arg - grouping object
        java.lang.IllegalArgumentException - if given argument is none of valid types
      • getDetection

        public Detection getDetection()
      • getRrGroup

        public java.lang.String getRrGroup()
      • getScanTime

        public org.opendaylight.yangtools.yang.common.Uint8 getScanTime()
      • isPropagateDmzlinkBw

        public java.lang.Boolean isPropagateDmzlinkBw()
      • isSoftReconfigBackup

        public java.lang.Boolean isSoftReconfigBackup()
      • isSplitAsOverride

        public java.lang.Boolean isSplitAsOverride()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> E$$ augmentation​(java.lang.Class<E$$> augmentationType)
      • setRrGroup

        public BgpBuilder setRrGroup​(java.lang.String value)
      • setScanTime

        public BgpBuilder setScanTime​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setScanTime

        public BgpBuilder setScanTime​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setScanTime(Uint8)} instead.
        Utility migration setter.
        value - field value in legacy type
        this builder
      • setPropagateDmzlinkBw

        public BgpBuilder setPropagateDmzlinkBw​(java.lang.Boolean value)
      • setSoftReconfigBackup

        public BgpBuilder setSoftReconfigBackup​(java.lang.Boolean value)
      • setSplitAsOverride

        public BgpBuilder setSplitAsOverride​(java.lang.Boolean value)
      • addAugmentation

        public BgpBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> augmentationType,
                                          org.opendaylight.yangtools.yang.binding.Augmentation<Bgp> augmentationValue)
      • removeAugmentation

        public BgpBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> augmentationType)
      • build

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