Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406

Class IfTunnelBuilder

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

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

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

    • Constructor Detail

      • IfTunnelBuilder

        public IfTunnelBuilder()

      • IfTunnelBuilder

        public IfTunnelBuilder​(IfTunnel base)

    • 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.genius.interfacemanager.rev160406.MonitorParams
        • org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelOptionalParams
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getMonitorConfig

        public java.util.List<MonitorConfig> getMonitorConfig()

      • getMonitorInterval

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

      • getTunnelDestination

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

      • getTunnelGateway

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

      • getTunnelInterfaceType

        public java.lang.Class<? extends TunnelTypeBase> getTunnelInterfaceType()

      • getTunnelOptions

        public java.util.List<TunnelOptions> getTunnelOptions()

      • getTunnelSource

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

      • getWeight

        public org.opendaylight.yangtools.yang.common.Uint16 getWeight()

      • isInternal

        public java.lang.Boolean isInternal()

      • isMonitorEnabled

        public java.lang.Boolean isMonitorEnabled()

      • isTunnelRemoteIpFlow

        public java.lang.Boolean isTunnelRemoteIpFlow()

      • isTunnelSourceIpFlow

        public java.lang.Boolean isTunnelSourceIpFlow()

      • setMonitorInterval

        public IfTunnelBuilder setMonitorInterval​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMonitorInterval

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

      • setTunnelDestination

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

      • setTunnelGateway

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

      • setTunnelSource

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

      • setWeight

        public IfTunnelBuilder setWeight​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setWeight

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

      • setInternal

        public IfTunnelBuilder setInternal​(java.lang.Boolean value)

      • setMonitorEnabled

        public IfTunnelBuilder setMonitorEnabled​(java.lang.Boolean value)

      • setTunnelRemoteIpFlow

        public IfTunnelBuilder setTunnelRemoteIpFlow​(java.lang.Boolean value)

      • setTunnelSourceIpFlow

        public IfTunnelBuilder setTunnelSourceIpFlow​(java.lang.Boolean value)

      • build

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