Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121

Class CreateFibEntryInputBuilder

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

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

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

    • Constructor Detail

      • CreateFibEntryInputBuilder

        public CreateFibEntryInputBuilder()

      • CreateFibEntryInputBuilder

        public CreateFibEntryInputBuilder​(FibEntryInputs arg)

      • CreateFibEntryInputBuilder

        public CreateFibEntryInputBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.InstructionList arg)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.FibEntryInputs
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.InstructionList
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getInstruction

        public java.util.List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> getInstruction()

      • getIpAddress

        public java.lang.String getIpAddress()

      • getServiceId

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

      • getSourceDpid

        public org.opendaylight.yangtools.yang.common.Uint64 getSourceDpid()

      • getVpnName

        public java.lang.String getVpnName()

      • augmentation

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

      • setInstruction

        public CreateFibEntryInputBuilder setInstruction​(java.util.List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> values)

      • setServiceId

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

      • setSourceDpid

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

      • build

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