Class ComputesBuilder

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

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

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

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

      • ComputesBuilder

        public ComputesBuilder()
      • ComputesBuilder

        public ComputesBuilder​(Computes base)
    • Method Detail

      • getComputeName

        public java.lang.String getComputeName()
      • getDpnId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
      • getNodeId

        public java.lang.String getNodeId()
      • getPortName

        public java.lang.String getPortName()
      • getPrefix

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
      • getTepIp

        public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getTepIp()
      • getZoneName

        public java.lang.String getZoneName()
      • augmentation

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

        public ComputesBuilder setComputeName​(java.lang.String value)
      • setDpnId

        public ComputesBuilder setDpnId​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setDpnId

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

        public ComputesBuilder setPortName​(java.lang.String value)
      • setPrefix

        public ComputesBuilder setPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
      • setTepIp

        public ComputesBuilder setTepIp​(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)
      • setZoneName

        public ComputesBuilder setZoneName​(java.lang.String value)
      • addAugmentation

        public ComputesBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Computes> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null
      • removeAugmentation

        public ComputesBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Computes>> 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
      • build

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