Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.instance.endpoint.local.remote.local.remote

Class RemoteBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Remote>, org.opendaylight.yangtools.concepts.CheckedBuilder<Remote,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class RemoteBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Remote>
    Class that builds RemoteBuilder 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: 

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

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

    • Constructor Detail

      • RemoteBuilder

        public RemoteBuilder()

      • RemoteBuilder

        public RemoteBuilder​(Remote base)

    • Method Detail

      • getNeighbor

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

      • getVirtualCircuitIdentifier

        public org.opendaylight.yangtools.yang.common.Uint32 getVirtualCircuitIdentifier()

      • augmentation

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

      • setNeighbor

        public RemoteBuilder setNeighbor​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setVirtualCircuitIdentifier

        public RemoteBuilder setVirtualCircuitIdentifier​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setVirtualCircuitIdentifier

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

      • addAugmentation

        public RemoteBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Remote>> augmentationType,
                                     org.opendaylight.yangtools.yang.binding.Augmentation<Remote> augmentationValue)

      • removeAugmentation

        public RemoteBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Remote>> augmentationType)

      • build

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