Class ImportRibsBuilder

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

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

       
         ImportRibsBuilder createTarget(int fooXyzzy, int barBaz) {
             return new ImportRibsBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • ImportRibsBuilder

        public ImportRibsBuilder()
      • ImportRibsBuilder

        public ImportRibsBuilder​(ImportRibs base)
    • Method Detail

      • getPolicyName

        public java.lang.String getPolicyName()
      • getProcessId

        public org.opendaylight.yangtools.yang.common.Uint32 getProcessId()
      • isBgpValidRoute

        public java.lang.Boolean isBgpValidRoute()
      • augmentation

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

        public ImportRibsBuilder setProcessId​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setProcessId

        @Deprecated(forRemoval=true)
        public ImportRibsBuilder setProcessId​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setProcessId(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setBgpValidRoute

        public ImportRibsBuilder setBgpValidRoute​(java.lang.Boolean value)
      • addAugmentation

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

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

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