Class FirewallPoliciesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.fwaas.rev150712.policies.attributes.FirewallPoliciesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FirewallPolicies>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FirewallPolicies,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FirewallPoliciesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FirewallPolicies>
Class that buildsFirewallPoliciesBuilder
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:
FirewallPoliciesBuilder createTarget(int fooXyzzy, int barBaz) { return new FirewallPoliciesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FirewallPoliciesBuilder, 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:
FirewallPoliciesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FirewallPoliciesBuilder()
FirewallPoliciesBuilder(FirewallPolicies base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FirewallPoliciesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicies> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicies>>
E$$augmentation(Class<E$$> augmentationType)
FirewallPolicies
build()
Map<FirewallPolicyKey,FirewallPolicy>
getFirewallPolicy()
FirewallPoliciesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicies>> augmentationType)
Remove an augmentation from this builder's product.FirewallPoliciesBuilder
setFirewallPolicy(List<FirewallPolicy> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFirewallPolicy(Map)
instead.FirewallPoliciesBuilder
setFirewallPolicy(Map<FirewallPolicyKey,FirewallPolicy> values)
-
-
-
Constructor Detail
-
FirewallPoliciesBuilder
public FirewallPoliciesBuilder()
-
FirewallPoliciesBuilder
public FirewallPoliciesBuilder(FirewallPolicies base)
-
-
Method Detail
-
getFirewallPolicy
public Map<FirewallPolicyKey,FirewallPolicy> getFirewallPolicy()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicies>> E$$ augmentation(Class<E$$> augmentationType)
-
setFirewallPolicy
public FirewallPoliciesBuilder setFirewallPolicy(Map<FirewallPolicyKey,FirewallPolicy> values)
-
setFirewallPolicy
@Deprecated(forRemoval=true) public FirewallPoliciesBuilder setFirewallPolicy(List<FirewallPolicy> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFirewallPolicy(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public FirewallPoliciesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicies> 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 FirewallPoliciesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FirewallPolicies>> 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 FirewallPolicies build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FirewallPolicies>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FirewallPolicies,IllegalArgumentException>
-
-