Interface SourcePortRange

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<SourcePortRange>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<AclTransportHeaderFields>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface SourcePortRange
    extends org.opendaylight.yangtools.yang.binding.ChildOf<AclTransportHeaderFields>, org.opendaylight.yangtools.yang.binding.Augmentable<SourcePortRange>
    Inclusive range representing source ports to be used. When only lower-port is present, it represents a single port.

    This class represents the following YANG schema fragment defined in module ietf-packet-fields

     container source-port-range {
       presence "Enables setting source port range";
       leaf lower-port {
         type inet:port-number;
       }
       leaf upper-port {
         type inet:port-number;
         must ". >= ../lower-port" {
           error-message
             "The upper-port must be greater than or equal to lower-port";
         }
       }
     }
     
    The schema path to identify an instance is ietf-packet-fields/acl-transport-header-fields/source-port-range

    To create instances of this class use SourcePortRangeBuilder.

    See Also:
    SourcePortRangeBuilder
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull SourcePortRange thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull SourcePortRange obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull SourcePortRange obj)
      Default implementation of Object.toString() contract for this interface.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLowerPort()
      Return lowerPort, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getUpperPort()
      Return upperPort, or null if it is not present.
      default java.lang.Class<SourcePortRange> implementedInterface()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default java.lang.Class<SourcePortRange> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull SourcePortRange obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull SourcePortRange thisObj,
                                     java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull SourcePortRange obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • getLowerPort

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLowerPort()
        Return lowerPort, or null if it is not present.
             
                 Lower boundary for port.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber lowerPort, or null if it is not present.
      • getUpperPort

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getUpperPort()
        Return upperPort, or null if it is not present.
             
                 Upper boundary for port . If existing, the upper port must be greater or equal
                 to lower-port.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber upperPort, or null if it is not present.