Class InterfaceAclBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InterfaceAcl>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceAcl,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InterfaceAclBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<InterfaceAcl>
Class that buildsInterfaceAclBuilder
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:
InterfaceAclBuilder createTarget(int fooXyzzy, int barBaz) { return new InterfaceAclBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceAclBuilder, 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:
InterfaceAclBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceAclBuilder()
InterfaceAclBuilder(InterfaceAcl base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InterfaceAcl
build()
java.util.Map<AllowedAddressPairsKey,AllowedAddressPairs>
getAllowedAddressPairs()
InterfaceAcl.InterfaceType
getInterfaceType()
java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>
getSecurityGroups()
java.util.Map<SubnetInfoKey,SubnetInfo>
getSubnetInfo()
java.lang.Boolean
isPortSecurityEnabled()
InterfaceAclBuilder
setAllowedAddressPairs(java.util.List<AllowedAddressPairs> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllowedAddressPairs(Map)
instead.InterfaceAclBuilder
setAllowedAddressPairs(java.util.Map<AllowedAddressPairsKey,AllowedAddressPairs> values)
InterfaceAclBuilder
setInterfaceType(InterfaceAcl.InterfaceType value)
InterfaceAclBuilder
setPortSecurityEnabled(java.lang.Boolean value)
InterfaceAclBuilder
setSecurityGroups(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
InterfaceAclBuilder
setSubnetInfo(java.util.List<SubnetInfo> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSubnetInfo(Map)
instead.InterfaceAclBuilder
setSubnetInfo(java.util.Map<SubnetInfoKey,SubnetInfo> values)
-
-
-
Constructor Detail
-
InterfaceAclBuilder
public InterfaceAclBuilder()
-
InterfaceAclBuilder
public InterfaceAclBuilder(InterfaceAcl base)
-
-
Method Detail
-
getAllowedAddressPairs
public java.util.Map<AllowedAddressPairsKey,AllowedAddressPairs> getAllowedAddressPairs()
-
getInterfaceType
public InterfaceAcl.InterfaceType getInterfaceType()
-
getSecurityGroups
public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getSecurityGroups()
-
getSubnetInfo
public java.util.Map<SubnetInfoKey,SubnetInfo> getSubnetInfo()
-
isPortSecurityEnabled
public java.lang.Boolean isPortSecurityEnabled()
-
setAllowedAddressPairs
public InterfaceAclBuilder setAllowedAddressPairs(java.util.Map<AllowedAddressPairsKey,AllowedAddressPairs> values)
-
setAllowedAddressPairs
@Deprecated(forRemoval=true) public InterfaceAclBuilder setAllowedAddressPairs(java.util.List<AllowedAddressPairs> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllowedAddressPairs(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:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setInterfaceType
public InterfaceAclBuilder setInterfaceType(InterfaceAcl.InterfaceType value)
-
setSecurityGroups
public InterfaceAclBuilder setSecurityGroups(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
-
setSubnetInfo
public InterfaceAclBuilder setSubnetInfo(java.util.Map<SubnetInfoKey,SubnetInfo> values)
-
setSubnetInfo
@Deprecated(forRemoval=true) public InterfaceAclBuilder setSubnetInfo(java.util.List<SubnetInfo> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSubnetInfo(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:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setPortSecurityEnabled
public InterfaceAclBuilder setPortSecurityEnabled(java.lang.Boolean value)
-
build
public InterfaceAcl build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InterfaceAcl>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceAcl,java.lang.IllegalArgumentException>
-
-