Module com.github.cowwoc.requirements10.java
Package com.github.cowwoc.requirements10.java.validator

Interface PrimitiveShortValidator

All Superinterfaces:
ComparableComponent<PrimitiveShortValidator,Short>, NegativeNumberComponent<PrimitiveShortValidator>, PositiveNumberComponent<PrimitiveShortValidator>, ValidatorComponent<PrimitiveShortValidator,Short>, ZeroNumberComponent<PrimitiveShortValidator>
public interface PrimitiveShortValidator extends ValidatorComponent<PrimitiveShortValidator,Short>, NegativeNumberComponent<PrimitiveShortValidator>, ZeroNumberComponent<PrimitiveShortValidator>, PositiveNumberComponent<PrimitiveShortValidator>, ComparableComponent<PrimitiveShortValidator,Short>
Validates the state of a short.

  • Method Details

    • getValue

      short getValue()
      Returns the value that is being validated.
      Returns:
      the value
      Throws:
      IllegalStateException - if a previous validation failed

    • getValueOrDefault

      short getValueOrDefault(short defaultValue)
      Returns the value that is being validated.
      Parameters:
      defaultValue - the fallback value in case of a validation failure
      Returns:
      the value, or defaultValue if a previous validation failed

    • isEqualTo

      PrimitiveShortValidator isEqualTo(short expected)
      Ensures that the value is equal to expected.
      Parameters:
      expected - the expected value
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is not equal to expected

    • isEqualTo

      PrimitiveShortValidator isEqualTo(short expected, String name)
      Ensures that the value is equal to expected.
      Parameters:
      expected - the expected value
      name - the name of the expected value
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • the value is not equal to expected

    • isNotEqualTo

      PrimitiveShortValidator isNotEqualTo(short unwanted)
      Ensures that the value is not equal to unwanted.
      Parameters:
      unwanted - the value to compare to
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is equal to unwanted

    • isNotEqualTo

      PrimitiveShortValidator isNotEqualTo(short unwanted, String name)
      Ensures that the value is not equal to unwanted.
      Parameters:
      unwanted - the value to compare to
      name - the name of the other value
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • the value is equal to unwanted

    • isMultipleOf

      PrimitiveShortValidator isMultipleOf(short factor)
      Ensures that the value is a multiple of factor.
      Parameters:
      factor - the number being multiplied
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is not a multiple of factor

    • isMultipleOf

      PrimitiveShortValidator isMultipleOf(short factor, String name)
      Ensures that the value is a multiple of factor.
      Parameters:
      factor - the number being multiplied
      name - the name of the factor
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • the value is not a multiple of factor

    • isNotMultipleOf

      PrimitiveShortValidator isNotMultipleOf(short factor)
      Ensures that the value is not a multiple of factor.
      Parameters:
      factor - the number being multiplied
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is a multiple of factor

    • isNotMultipleOf

      PrimitiveShortValidator isNotMultipleOf(short factor, String name)
      Ensures that the value is not a multiple of factor.
      Parameters:
      factor - the number being multiplied
      name - the name of the factor
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • value is a multiple of factor

    • isLessThan

      PrimitiveShortValidator isLessThan(short maximumExclusive)
      Ensures that the value is less than an upper bound.
      Parameters:
      maximumExclusive - the exclusive upper bound
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is greater than or equal to maximumExclusive

    • isLessThan

      PrimitiveShortValidator isLessThan(short maximumExclusive, String name)
      Ensures that the value is less than an upper bound.
      Parameters:
      maximumExclusive - the exclusive upper bound
      name - the name of the upper bound
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • the value is greater than or equal to maximumExclusive

    • isLessThanOrEqualTo

      PrimitiveShortValidator isLessThanOrEqualTo(short maximumInclusive)
      Ensures that the value is less than or equal to a maximum value.
      Parameters:
      maximumInclusive - the inclusive upper value
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is greater than maximumInclusive

    • isLessThanOrEqualTo

      PrimitiveShortValidator isLessThanOrEqualTo(short maximumInclusive, String name)
      Ensures that the value is less than or equal to a maximum value.
      Parameters:
      maximumInclusive - the maximum value
      name - the name of the maximum value
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • the value is greater than maximumInclusive

    • isGreaterThanOrEqualTo

      PrimitiveShortValidator isGreaterThanOrEqualTo(short minimumInclusive)
      Ensures that the value is greater than or equal to a minimum value.
      Parameters:
      minimumInclusive - the minimum value
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is less than minimumInclusive

    • isGreaterThanOrEqualTo

      PrimitiveShortValidator isGreaterThanOrEqualTo(short minimumInclusive, String name)
      Ensures that the value is greater than or equal a minimum value.
      Parameters:
      minimumInclusive - the minimum value
      name - the name of the minimum value
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • the value is less than minimumInclusive

    • isGreaterThan

      PrimitiveShortValidator isGreaterThan(short minimumExclusive)
      Ensures that the value is greater than a lower bound.
      Parameters:
      minimumExclusive - the exclusive lower bound
      Returns:
      this
      Throws:
      IllegalArgumentException - if the value is less than or equal to minimumExclusive

    • isGreaterThan

      PrimitiveShortValidator isGreaterThan(short minimumExclusive, String name)
      Ensures that the value is greater than a lower bound.
      Parameters:
      minimumExclusive - the exclusive lower bound
      name - the name of the lower bound
      Returns:
      this
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if:
      • name is empty
      • name contains whitespace
      • name is already in use by the value being validated or the validator context
      • the value is less or equal to minimumExclusive

    • isBetween

      PrimitiveShortValidator isBetween(short minimumInclusive, short maximumExclusive)
      Ensures that the value is within a range.
      Parameters:
      minimumInclusive - the lower bound of the range (inclusive)
      maximumExclusive - the upper bound of the range (exclusive)
      Returns:
      this
      Throws:
      IllegalArgumentException - if:
      • minimumInclusive is greater than maximumExclusive
      • the value is greater than or equal to maximumExclusive

    • isBetween

      PrimitiveShortValidator isBetween(short minimum, boolean minimumIsInclusive, short maximum, boolean maximumIsInclusive)
      Ensures that the value is within a range.
      Parameters:
      minimum - the lower bound of the range
      minimumIsInclusive - true if the lower bound of the range is inclusive
      maximum - the upper bound of the range
      maximumIsInclusive - true if the upper bound of the range is inclusive
      Returns:
      this
      Throws:
      IllegalArgumentException - if:
      • minimum is greater than maximum
      • minimumIsInclusive is true and the value is less than minimum
      • minimumIsInclusive is false and the value is less than or equal to minimum
      • maximumIsInclusive is true and the value is greater than maximum
      • maximumIsInclusive is false and the value is greater than or equal to maximum