Class SendNeighborSolicitationToOfGroupInputBuilder

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

    @Generated("mdsal-binding-generator")
    public class SendNeighborSolicitationToOfGroupInputBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<SendNeighborSolicitationToOfGroupInput>
    Class that builds SendNeighborSolicitationToOfGroupInputBuilder 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:

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

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

      • SendNeighborSolicitationToOfGroupInputBuilder

        public SendNeighborSolicitationToOfGroupInputBuilder()
    • Method Detail

      • getDpId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpId()
      • getOfGroupId

        public org.opendaylight.yangtools.yang.common.Uint32 getOfGroupId()
      • getSourceIpv6

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getSourceIpv6()
      • getSourceLlAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getSourceLlAddress()
      • getTargetIpAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getTargetIpAddress()
      • augmentation

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

        @Deprecated(forRemoval=true)
        public SendNeighborSolicitationToOfGroupInputBuilder setDpId​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setDpId(Uint64) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setOfGroupId

        @Deprecated(forRemoval=true)
        public SendNeighborSolicitationToOfGroupInputBuilder setOfGroupId​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • removeAugmentation

        public SendNeighborSolicitationToOfGroupInputBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SendNeighborSolicitationToOfGroupInput>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder