Class FirewallPolicyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.fwaas.rev150712.policies.attributes.firewall.policies.FirewallPolicyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FirewallPolicy>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FirewallPolicy,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FirewallPolicyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FirewallPolicy>
Class that buildsFirewallPolicyBuilder
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:
FirewallPolicyBuilder createTarget(int fooXyzzy, int barBaz) { return new FirewallPolicyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FirewallPolicyBuilder, 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:
FirewallPolicyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FirewallPolicyBuilder()
FirewallPolicyBuilder(BaseAttributes arg)
FirewallPolicyBuilder(IdAttributes arg)
FirewallPolicyBuilder(FirewallPolicyAttributes arg)
FirewallPolicyBuilder(FirewallPolicy base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FirewallPolicyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicy> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicy>>
E$$augmentation(Class<E$$> augmentationType)
FirewallPolicy
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getAudited()
String
getName()
String
getProjectId()
Long
getRevisionNumber()
Boolean
getShared()
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()
FirewallPolicyKey
key()
FirewallPolicyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicy>> augmentationType)
Remove an augmentation from this builder's product.FirewallPolicyBuilder
setAudited(Boolean value)
FirewallPolicyBuilder
setName(String value)
FirewallPolicyBuilder
setProjectId(String value)
FirewallPolicyBuilder
setRevisionNumber(Long value)
FirewallPolicyBuilder
setShared(Boolean value)
FirewallPolicyBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FirewallPolicyBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
FirewallPolicyBuilder
withKey(FirewallPolicyKey key)
-
-
-
Constructor Detail
-
FirewallPolicyBuilder
public FirewallPolicyBuilder()
-
FirewallPolicyBuilder
public FirewallPolicyBuilder(BaseAttributes arg)
-
FirewallPolicyBuilder
public FirewallPolicyBuilder(IdAttributes arg)
-
FirewallPolicyBuilder
public FirewallPolicyBuilder(FirewallPolicyAttributes arg)
-
FirewallPolicyBuilder
public FirewallPolicyBuilder(FirewallPolicy 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:- IdAttributes
- BaseAttributes
- FirewallPolicyAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FirewallPolicyKey key()
-
getAudited
public Boolean getAudited()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getShared
public Boolean getShared()
-
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<FirewallPolicy>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FirewallPolicyBuilder withKey(FirewallPolicyKey key)
-
setAudited
public FirewallPolicyBuilder setAudited(Boolean value)
-
setName
public FirewallPolicyBuilder setName(String value)
-
setProjectId
public FirewallPolicyBuilder setProjectId(String value)
-
setRevisionNumber
public FirewallPolicyBuilder setRevisionNumber(Long value)
-
setShared
public FirewallPolicyBuilder setShared(Boolean value)
-
setTenantId
public FirewallPolicyBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public FirewallPolicyBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public FirewallPolicyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicy> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public FirewallPolicyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicy>> 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 FirewallPolicy build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FirewallPolicy>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FirewallPolicy,IllegalArgumentException>
-
-