Class 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>

    @Generated("mdsal-binding-generator")
    public class InterfaceAclBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<InterfaceAcl>
    Class that builds InterfaceAclBuilder 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 Detail

      • InterfaceAclBuilder

        public InterfaceAclBuilder()
      • InterfaceAclBuilder

        public InterfaceAclBuilder​(InterfaceAcl base)
    • Method Detail

      • getPortSecurityEnabled

        public java.lang.Boolean getPortSecurityEnabled()
      • isPortSecurityEnabled

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

        public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getSecurityGroups()
      • 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.
        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 key
        java.lang.NullPointerException - if the list contains a null entry
      • setPortSecurityEnabled

        public InterfaceAclBuilder setPortSecurityEnabled​(java.lang.Boolean 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

        @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.
        Use setSubnetInfo(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 key
        java.lang.NullPointerException - if the list contains a null entry
      • build

        public InterfaceAcl build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<InterfaceAcl>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceAcl,​java.lang.IllegalArgumentException>