Package io.dropwizard.validation

Annotation Interface PortRange

@Target({METHOD,FIELD,ANNOTATION_TYPE,TYPE_USE}) @Retention(RUNTIME) @Constraint(validatedBy=PortRangeValidator.class) @Documented public @interface PortRange
A constraint that allows one to specify a port range, but still allow 0 as the port value to indicate dynamically allocated ports.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>[]
    groups
    The groups the constraint belongs to.
    int
    max
    The maximum value of the port range the validated int must be in.
    String
    message
    The validation message for this constraint.
    int
    min
    The minimum value of the port range the validated int must be in.
    Class<? extends jakarta.validation.Payload>[]
    payload
    The payloads of this constraint.

  • Element Details

    • min

      int min
      The minimum value of the port range the validated int must be in.
      Returns:
      the minimum value
      Default:
      1

    • max

      int max
      The maximum value of the port range the validated int must be in.
      Returns:
      the maximum value
      Default:
      65535

    • message

      String message
      The validation message for this constraint.
      Returns:
      the message
      Default:
      "{org.hibernate.validator.constraints.Range.message}"

    • groups

      Class<?>[] groups
      The groups the constraint belongs to.
      Returns:
      an array of classes representing the groups
      Default:
      {}

    • payload

      Class<? extends jakarta.validation.Payload>[] payload
      The payloads of this constraint.
      Returns:
      the array of payload classes
      Default:
      {}