Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.vpnaas.rev150712.ikepolicies.attributes.ike.policies

Class IkepolicyBuilder

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

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

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

    • Constructor Detail

      • IkepolicyBuilder

        public IkepolicyBuilder()

      • IkepolicyBuilder

        public IkepolicyBuilder​(IdAttributes arg)

      • IkepolicyBuilder

        public IkepolicyBuilder​(Ikepolicy 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:
        • IkepolicyAttributes
        • IdAttributes
        • BaseAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAuthAlgorithm

        public String getAuthAlgorithm()

      • getEncryptionAlgorithm

        public String getEncryptionAlgorithm()

      • getIkeVersion

        public String getIkeVersion()

      • getLifetime

        public Lifetime getLifetime()

      • getName

        public String getName()

      • getPfs

        public String getPfs()

      • getPhaseNegotiationMode

        public String getPhaseNegotiationMode()

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • 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()

      • augmentation

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

      • setTenantId

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

      • setUuid

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

      • addAugmentation

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