Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.fwaas.rev150712.rules.attributes.firewall.rules

Class FirewallRuleBuilder

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

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

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

    • Constructor Detail

      • FirewallRuleBuilder

        public FirewallRuleBuilder()

      • FirewallRuleBuilder

        public FirewallRuleBuilder​(BaseAttributes arg)

      • FirewallRuleBuilder

        public FirewallRuleBuilder​(IdAttributes arg)

      • FirewallRuleBuilder

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

      • getDestinationPortRangeMax

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

      • getDestinationPortRangeMin

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

      • getEnabled

        public Boolean getEnabled()

      • isEnabled

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

      • getFirewallPolicyId

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

      • getName

        public String getName()

      • getPosition

        public Short getPosition()

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getShared

        public Boolean getShared()

      • isShared

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

      • getSourcePortRangeMax

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

      • getSourcePortRangeMin

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

      • 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<FirewallRule>> E$$ augmentation​(Class<E$$> augmentationType)

      • setDestinationPortRangeMax

        public FirewallRuleBuilder setDestinationPortRangeMax​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setDestinationPortRangeMin

        public FirewallRuleBuilder setDestinationPortRangeMin​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setFirewallPolicyId

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

      • setSourcePortRangeMax

        public FirewallRuleBuilder setSourcePortRangeMax​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setSourcePortRangeMin

        public FirewallRuleBuilder setSourcePortRangeMin​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setTenantId

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

      • setUuid

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

      • addAugmentation

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