Character (Groovy JDK enhancements)

Package: java.lang

## Class Character

- - ### Methods Summary

    Methods
    Return type | Name and parameters
    --- | ---
    `boolean` | `asBoolean()` Coerce a character to a boolean value.
    `int` | `compareTo(Character right)` Compare two Characters.
    `int` | `compareTo(Number right)` Compare a Character and a Number.
    `Number` | `div(Character right)` Divide one Character by another.
    `Number` | `div(Number right)` Divide a Character by a Number.
    `Number` | `intdiv(Character right)` Integer Divide two Characters.
    `Number` | `intdiv(Number right)` Integer Divide a Character by a Number.
    `boolean` | `isDigit()` Determines if a character is a digit.
    `boolean` | `isLetter()` Determines if a character is a letter.
    `boolean` | `isLetterOrDigit()` Determines if a character is a letter or digit.
    `boolean` | `isLowerCase()` Determine if a Character is lowercase.
    `boolean` | `isUpperCase()` Determine if a Character is uppercase.
    `boolean` | `isWhitespace()` Determines if a character is a whitespace character.
    `Number` | `minus(Character right)` Subtract one Character from another.
    `Number` | `minus(Number right)` Subtract a Number from a Character.
    `Number` | `multiply(Character right)` Multiply two Characters.
    `Number` | `multiply(Number right)` Multiply a Character by a Number.
    `Character` | `next()` Increment a Character by one.
    `Number` | `plus(Character right)` Add one Character to another.
    `Number` | `plus(Number right)` Add a Character and a Number.
    `Character` | `previous()` Decrement a Character by one.
    `char` | `toLowerCase()` Converts the character to lowercase.
    `char` | `toUpperCase()` Converts the character to uppercase.

  - #### Methods inherited from class java.lang.Object

    `addShutdownHook`, `any`, `any`, `asBoolean`, `asType`, `collect`, `collect`, `collect`, `dump`, `each`, `eachMatch`, `eachMatch`, `eachWithIndex`, `every`, `every`, `find`, `find`, `findAll`, `findAll`, `findIndexOf`, `findIndexOf`, `findIndexValues`, `findIndexValues`, `findLastIndexOf`, `findLastIndexOf`, `findResult`, `findResult`, `findResult`, `findResult`, `getAt`, `getMetaClass`, `getMetaPropertyValues`, `getProperties`, `grep`, `grep`, `hasProperty`, `identity`, `inject`, `inject`, `inspect`, `invokeMethod`, `is`, `isCase`, `isNotCase`, `iterator`, `metaClass`, `print`, `print`, `printf`, `printf`, `println`, `println`, `println`, `putAt`, `respondsTo`, `respondsTo`, `setMetaClass`, `split`, `sprintf`, `sprintf`, `stream`, `tap`, `toString`, `use`, `use`, `use`, `with`, `with`, `withCloseable`, `withStream`, `withTraits`

  - #### Methods inherited from interface java.lang.Comparable

    `numberAwareCompareTo`

- - ### Methods Detail

    - #### public boolean asBoolean()

      Coerce a character to a boolean value. A character is coerced to false if it's character value is equal to 0, and to true otherwise.

      Returns:
        the boolean value
      Since:
        1.7.0

    - #### public int compareTo(Character right)

      Compare two Characters. The ordinal values of the Characters are compared (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - a Character
      Returns:
        the result of the comparison
      Since:
        1.0

    - #### public int compareTo(Number right)

      Compare a Character and a Number. The ordinal value of the Character is used in the comparison (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - a Number
      Returns:
        the result of the comparison
      Since:
        1.0

    - #### public Number div(Character right)

      Divide one Character by another. The ordinal values of the Characters are used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - another Character
      Returns:
        the Number corresponding to the division of left by right
      Since:
        1.0

    - #### public Number div(Number right)

      Divide a Character by a Number. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - a Number
      Returns:
        the Number corresponding to the division of left by right
      Since:
        1.0

    - #### public Number intdiv(Character right)

      Integer Divide two Characters. The ordinal values of the Characters are used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - another Character
      Returns:
        a Number (an Integer) resulting from the integer division operation
      Since:
        1.0

    - #### public Number intdiv(Number right)

      Integer Divide a Character by a Number. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - a Number
      Returns:
        a Number (an Integer) resulting from the integer division operation
      Since:
        1.0

    - #### public boolean isDigit()

      Determines if a character is a digit. Synonym for 'Character.isDigit(this)'.

      Returns:
        true if the character is a digit
      Since:
        1.5.7
      See Also:
        Character#isDigit(char)

    - #### public boolean isLetter()

      Determines if a character is a letter. Synonym for 'Character.isLetter(this)'.

      Returns:
        true if the character is a letter
      Since:
        1.5.7
      See Also:
        Character#isLetter(char)

    - #### public boolean isLetterOrDigit()

      Determines if a character is a letter or digit. Synonym for 'Character.isLetterOrDigit(this)'.

      Returns:
        true if the character is a letter or digit
      Since:
        1.5.7
      See Also:
        Character#isLetterOrDigit(char)

    - #### public boolean isLowerCase()

      Determine if a Character is lowercase. Synonym for 'Character.isLowerCase(this)'.

      Returns:
        true if the character is lowercase
      Since:
        1.5.7
      See Also:
        Character#isLowerCase(char)

    - #### public boolean isUpperCase()

      Determine if a Character is uppercase. Synonym for 'Character.isUpperCase(this)'.

      Returns:
        true if the character is uppercase
      Since:
        1.5.7
      See Also:
        Character#isUpperCase(char)

    - #### public boolean isWhitespace()

      Determines if a character is a whitespace character. Synonym for 'Character.isWhitespace(this)'.

      Returns:
        true if the character is a whitespace character
      Since:
        1.5.7
      See Also:
        Character#isWhitespace(char)

    - #### public Number minus(Character right)

      Subtract one Character from another. The ordinal values of the Characters is used in the comparison (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - a Character
      Returns:
        the Number corresponding to the subtraction of right from left
      Since:
        1.0

    - #### public Number minus(Number right)

      Subtract a Number from a Character. The ordinal value of the Character is used in the subtraction (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - a Number
      Returns:
        the Number corresponding to the subtraction of right from left
      Since:
        1.0

    - #### public Number multiply(Character right)

      Multiply two Characters. The ordinal values of the Characters are used in the multiplication (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - another Character
      Returns:
        the Number corresponding to the multiplication of left by right
      Since:
        1.0

    - #### public Number multiply(Number right)

      Multiply a Character by a Number. The ordinal value of the Character is used in the multiplication (the ordinal value is the unicode value which for simple character sets is the ASCII value).

      Parameters:
        `right` - a Number
      Returns:
        the Number corresponding to the multiplication of left by right
      Since:
        1.0

    - #### public Character next()

      Increment a Character by one.

      Returns:
        an incremented Character
      Since:
        1.5.7

    - #### public Number plus(Character right)

      Add one Character to another. The ordinal values of the Characters are used in the addition (the ordinal value is the unicode value which for simple character sets is the ASCII value). This operation will always create a new object for the result, while the operands remain unchanged.

      Parameters:
        `right` - a Character
      Returns:
        the Number corresponding to the addition of left and right
      Since:
        1.0
      See Also:
        Number#plus(java.lang.Character)

    - #### public Number plus(Number right)

      Add a Character and a Number. The ordinal value of the Character is used in the addition (the ordinal value is the unicode value which for simple character sets is the ASCII value). This operation will always create a new object for the result, while the operands remain unchanged.

      Parameters:
        `right` - a Number
      Returns:
        the Number corresponding to the addition of left and right
      Since:
        1.0
      See Also:
        Integer#valueOf(int)

    - #### public Character previous()

      Decrement a Character by one.

      Returns:
        a decremented Character
      Since:
        1.5.7

    - #### public char toLowerCase()

      Converts the character to lowercase. Synonym for 'Character.toLowerCase(this)'.

      Returns:
        the lowercase equivalent of the character, if any; otherwise, the character itself.
      Since:
        1.5.7
      See Also:
        Character#isLowerCase(char)
        String#toLowerCase()

    - #### public char toUpperCase()

      Converts the character to uppercase. Synonym for 'Character.toUpperCase(this)'.

      Returns:
        the uppercase equivalent of the character, if any; otherwise, the character itself.
      Since:
        1.5.7
      See Also:
        Character#isUpperCase(char)
        String#toUpperCase()