Class ControllerEntryBuilder

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

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

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

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

      • ControllerEntryBuilder

        public ControllerEntryBuilder()
      • ControllerEntryBuilder

        public ControllerEntryBuilder​(ControllerEntry base)
    • Method Detail

      • getControllerUuid

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getControllerUuid()
      • getInactivityProbe

        public org.opendaylight.yangtools.yang.common.Uint32 getInactivityProbe()
      • getMaxBackoff

        public org.opendaylight.yangtools.yang.common.Uint32 getMaxBackoff()
      • getTarget

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTarget()
      • isIsConnected

        public Boolean isIsConnected()
      • augmentation

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

        public ControllerEntryBuilder setControllerUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
      • setInactivityProbe

        public ControllerEntryBuilder setInactivityProbe​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setInactivityProbe

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

        public ControllerEntryBuilder setMaxBackoff​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setMaxBackoff

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

        public ControllerEntryBuilder setTarget​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)