Class FirewallRuleBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.fwaas.rev150712.rules.attributes.firewall.rules.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>
public class FirewallRuleBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FirewallRule>
Class that buildsFirewallRuleBuilder
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 Summary
Constructors Constructor Description FirewallRuleBuilder()
FirewallRuleBuilder(BaseAttributes arg)
FirewallRuleBuilder(IdAttributes arg)
FirewallRuleBuilder(FirewallRuleAttributes arg)
FirewallRuleBuilder(FirewallRule base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FirewallRuleBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.FirewallRuleBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule>>
E$$augmentation(Class<E$$> augmentationType)
FirewallRule
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends ActionBase>
getAction()
IpPrefixOrAddress
getDestinationIpAddr()
org.opendaylight.yangtools.yang.common.Uint16
getDestinationPortRangeMax()
org.opendaylight.yangtools.yang.common.Uint16
getDestinationPortRangeMin()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getFirewallPolicyId()
Class<? extends IpVersionBase>
getIpVersion()
String
getName()
Short
getPosition()
String
getProjectId()
FirewallRuleAttributes.Protocol
getProtocol()
Long
getRevisionNumber()
IpPrefixOrAddress
getSourceIpAddr()
org.opendaylight.yangtools.yang.common.Uint16
getSourcePortRangeMax()
org.opendaylight.yangtools.yang.common.Uint16
getSourcePortRangeMin()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
Boolean
isEnabled()
Boolean
isShared()
FirewallRuleKey
key()
FirewallRuleBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule>> augmentationType)
Remove an augmentation from this builder's product.FirewallRuleBuilder
setAction(Class<? extends ActionBase> value)
FirewallRuleBuilder
setDestinationIpAddr(IpPrefixOrAddress value)
FirewallRuleBuilder
setDestinationPortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDestinationPortRangeMax(Uint16)
instead.FirewallRuleBuilder
setDestinationPortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
FirewallRuleBuilder
setDestinationPortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDestinationPortRangeMin(Uint16)
instead.FirewallRuleBuilder
setDestinationPortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
FirewallRuleBuilder
setEnabled(Boolean value)
FirewallRuleBuilder
setFirewallPolicyId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FirewallRuleBuilder
setIpVersion(Class<? extends IpVersionBase> value)
FirewallRuleBuilder
setName(String value)
FirewallRuleBuilder
setPosition(Short value)
FirewallRuleBuilder
setProjectId(String value)
FirewallRuleBuilder
setProtocol(FirewallRuleAttributes.Protocol value)
FirewallRuleBuilder
setRevisionNumber(Long value)
FirewallRuleBuilder
setShared(Boolean value)
FirewallRuleBuilder
setSourceIpAddr(IpPrefixOrAddress value)
FirewallRuleBuilder
setSourcePortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourcePortRangeMax(Uint16)
instead.FirewallRuleBuilder
setSourcePortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
FirewallRuleBuilder
setSourcePortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourcePortRangeMin(Uint16)
instead.FirewallRuleBuilder
setSourcePortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
FirewallRuleBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FirewallRuleBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FirewallRuleBuilder
withKey(FirewallRuleKey key)
-
-
-
Constructor Detail
-
FirewallRuleBuilder
public FirewallRuleBuilder()
-
FirewallRuleBuilder
public FirewallRuleBuilder(BaseAttributes arg)
-
FirewallRuleBuilder
public FirewallRuleBuilder(IdAttributes arg)
-
FirewallRuleBuilder
public FirewallRuleBuilder(FirewallRuleAttributes 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
-
key
public FirewallRuleKey key()
-
getAction
public Class<? extends ActionBase> getAction()
-
getDestinationIpAddr
public IpPrefixOrAddress getDestinationIpAddr()
-
getDestinationPortRangeMax
public org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMax()
-
getDestinationPortRangeMin
public org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMin()
-
getFirewallPolicyId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getFirewallPolicyId()
-
getIpVersion
public Class<? extends IpVersionBase> getIpVersion()
-
getName
public String getName()
-
getPosition
public Short getPosition()
-
getProjectId
public String getProjectId()
-
getProtocol
public FirewallRuleAttributes.Protocol getProtocol()
-
getRevisionNumber
public Long getRevisionNumber()
-
getSourceIpAddr
public IpPrefixOrAddress getSourceIpAddr()
-
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()
-
isEnabled
public Boolean isEnabled()
-
isShared
public Boolean isShared()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FirewallRuleBuilder withKey(FirewallRuleKey key)
-
setAction
public FirewallRuleBuilder setAction(Class<? extends ActionBase> value)
-
setDestinationIpAddr
public FirewallRuleBuilder setDestinationIpAddr(IpPrefixOrAddress value)
-
setDestinationPortRangeMax
public FirewallRuleBuilder setDestinationPortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDestinationPortRangeMax
@Deprecated(forRemoval=true) public FirewallRuleBuilder setDestinationPortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDestinationPortRangeMax(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDestinationPortRangeMin
public FirewallRuleBuilder setDestinationPortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDestinationPortRangeMin
@Deprecated(forRemoval=true) public FirewallRuleBuilder setDestinationPortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDestinationPortRangeMin(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setFirewallPolicyId
public FirewallRuleBuilder setFirewallPolicyId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setIpVersion
public FirewallRuleBuilder setIpVersion(Class<? extends IpVersionBase> value)
-
setName
public FirewallRuleBuilder setName(String value)
-
setPosition
public FirewallRuleBuilder setPosition(Short value)
-
setProjectId
public FirewallRuleBuilder setProjectId(String value)
-
setProtocol
public FirewallRuleBuilder setProtocol(FirewallRuleAttributes.Protocol value)
-
setRevisionNumber
public FirewallRuleBuilder setRevisionNumber(Long value)
-
setSourceIpAddr
public FirewallRuleBuilder setSourceIpAddr(IpPrefixOrAddress value)
-
setSourcePortRangeMax
public FirewallRuleBuilder setSourcePortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSourcePortRangeMax
@Deprecated(forRemoval=true) public FirewallRuleBuilder setSourcePortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourcePortRangeMax(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSourcePortRangeMin
public FirewallRuleBuilder setSourcePortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSourcePortRangeMin
@Deprecated(forRemoval=true) public FirewallRuleBuilder setSourcePortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourcePortRangeMin(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
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)
-
setEnabled
public FirewallRuleBuilder setEnabled(Boolean value)
-
setShared
public FirewallRuleBuilder setShared(Boolean 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
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public FirewallRuleBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FirewallRule> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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
-
build
public FirewallRule build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FirewallRule>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FirewallRule,IllegalArgumentException>
-
-