Class BgpRouterBuilder

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

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

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

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

      • BgpRouterBuilder

        public BgpRouterBuilder()
      • BgpRouterBuilder

        public BgpRouterBuilder​(BgpRouter base)
    • Method Detail

      • getLocalAsIdentifier

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getLocalAsIdentifier()
      • getLocalAsNumber

        public org.opendaylight.yangtools.yang.common.Uint32 getLocalAsNumber()
      • getRpkiConfig

        public RpkiConfig getRpkiConfig()
      • getRtfilter

        public Rtfilter getRtfilter()
      • getVpnv4

        public Vpnv4 getVpnv4()
      • getVpnv6

        public Vpnv6 getVpnv6()
      • augmentation

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

        public BgpRouterBuilder setLocalAsIdentifier​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      • setLocalAsNumber

        public BgpRouterBuilder setLocalAsNumber​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setLocalAsNumber

        public BgpRouterBuilder setLocalAsNumber​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setLocalAsNumber(Uint32)} instead.
        Utility migration setter.
        value - field value in legacy type
        this builder
      • addAugmentation

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

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

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