Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.ipsecconnections.attributes.ipsec.site.connections

Class IpsecsiteconnectionBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Ipsecsiteconnection>, org.opendaylight.yangtools.concepts.CheckedBuilder<Ipsecsiteconnection,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class IpsecsiteconnectionBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Ipsecsiteconnection>
    Class that builds IpsecsiteconnectionBuilder 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: 

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

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

    • Constructor Detail

      • IpsecsiteconnectionBuilder

        public IpsecsiteconnectionBuilder()

      • IpsecsiteconnectionBuilder

        public IpsecsiteconnectionBuilder​(BaseAttributes arg)

      • IpsecsiteconnectionBuilder

        public IpsecsiteconnectionBuilder​(IdAttributes arg)

      • IpsecsiteconnectionBuilder

        public IpsecsiteconnectionBuilder​(AdminAttributes 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.neutron.attrs.rev150712.AdminAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.IpsecconnectionAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAdminStateUp

        public Boolean getAdminStateUp()

      • isAdminStateUp

        @Deprecated(forRemoval=true)
public final Boolean isAdminStateUp()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getAuthMode

        public String getAuthMode()

      • getDpd

        public Dpd getDpd()

      • getIkepolicyId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getIkepolicyId()

      • getInitiator

        public String getInitiator()

      • getIpsecpolicyId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getIpsecpolicyId()

      • getMtu

        public Short getMtu()

      • getName

        public String getName()

      • getPeerAddress

        public String getPeerAddress()

      • getPeerCidrs

        public List<String> getPeerCidrs()

      • getPeerId

        public String getPeerId()

      • getProjectId

        public String getProjectId()

      • getPsk

        public String getPsk()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getRouteMode

        public String getRouteMode()

      • getStatus

        public String getStatus()

      • getTenantId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()

      • getUuid

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()

      • getVpnserviceId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnserviceId()

      • augmentation

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

      • setIkepolicyId

        public IpsecsiteconnectionBuilder setIkepolicyId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setIpsecpolicyId

        public IpsecsiteconnectionBuilder setIpsecpolicyId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setTenantId

        public IpsecsiteconnectionBuilder setTenantId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setUuid

        public IpsecsiteconnectionBuilder setUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setVpnserviceId

        public IpsecsiteconnectionBuilder setVpnserviceId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • addAugmentation

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

      • removeAugmentation

        public IpsecsiteconnectionBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipsecsiteconnection>> 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