scala.runtime

# RichChar

#### final class RichChar extends AnyVal with IntegralProxy[Char]

Source
  RichChar.scala

Linear Supertypes
IntegralProxy[Char], RangedProxy[Char], ScalaWholeNumberProxy[Char], ScalaNumberProxy[Char], OrderedProxy[Char], math.Ordered[Char], Comparable[Char], Typed[Char], Proxy, ScalaNumericAnyConversions, AnyVal, NotNull, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. RichChar
2. IntegralProxy
3. RangedProxy
4. ScalaWholeNumberProxy
5. ScalaNumberProxy
6. OrderedProxy
7. Ordered
8. Comparable
9. Typed
10. Proxy
11. ScalaNumericAnyConversions
12. AnyVal
13. NotNull
14. Any

Implicitly

1. by any2stringadd
2. by any2stringfmt
3. by any2ArrowAssoc
4. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new RichChar(self: Char)

### Type Members

1. #### type ResultWithoutStep = NumericRange[Char]

   Definition Classes
     IntegralProxy → RangedProxy

### Value Members

1. #### final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

     `true` if !(this == that), false otherwise.

   Definition Classes
     Any

2. #### final def ##(): Int

   Equivalent to `x.hashCode` except for boxed numeric types and `null`.

   Equivalent to `x.hashCode` except for boxed numeric types and `null`. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For `null` returns a hashcode where `null.hashCode` throws a `NullPointerException`.

   returns

     a hash value consistent with ==

   Definition Classes
     Any

3. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from RichChar to StringAdd performed by method any2stringadd in scala.Predef.
   Definition Classes
     StringAdd

4. #### def ->[B](y: B): (RichChar, B)

   Implicit information
     This member is added by an implicit conversion from RichChar to ArrowAssoc[RichChar] performed by method any2ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

5. #### def <(that: Char): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Definition Classes
     Ordered

6. #### def <=(that: Char): Boolean

   Returns true if `this` is less than or equal to `that`.

   Returns true if `this` is less than or equal to `that`.

   Definition Classes
     Ordered

7. #### final def ==(arg0: Any): Boolean

   Test two objects for equality.

   Test two objects for equality. The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   Definition Classes
     Any

8. #### def >(that: Char): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Definition Classes
     Ordered

9. #### def >=(that: Char): Boolean

   Returns true if `this` is greater than or equal to `that`.

   Returns true if `this` is greater than or equal to `that`.

   Definition Classes
     Ordered

10. #### def abs: Char

    Definition Classes
      ScalaNumberProxy

11. #### def asDigit: Int

12. #### final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type `T0`.

    Cast the receiver object to be of type `T0`.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression `1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression `List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

      the receiver object.

    Definition Classes
      Any
    Exceptions thrown
      ClassCastException

      if the receiver object is not an instance of the erasure of type `T0`.

13. #### def byteValue(): Byte

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

14. #### def compare(y: Char): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Implement this method to determine how instances of A will be sorted.

    Returns `x` where:

    - `x < 0` when `this < that`
    - `x == 0` when `this == that`
    - `x > 0` when `this > that`
    Definition Classes
      OrderedProxy → Ordered

15. #### def compareTo(that: Char): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Definition Classes
      Ordered → Comparable

16. #### def doubleValue(): Double

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

17. #### def ensuring(cond: (RichChar) ⇒ Boolean, msg: ⇒ Any): RichChar

    Implicit information
      This member is added by an implicit conversion from RichChar to Ensuring[RichChar] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

18. #### def ensuring(cond: (RichChar) ⇒ Boolean): RichChar

    Implicit information
      This member is added by an implicit conversion from RichChar to Ensuring[RichChar] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

19. #### def ensuring(cond: Boolean, msg: ⇒ Any): RichChar

    Implicit information
      This member is added by an implicit conversion from RichChar to Ensuring[RichChar] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

20. #### def ensuring(cond: Boolean): RichChar

    Implicit information
      This member is added by an implicit conversion from RichChar to Ensuring[RichChar] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

21. #### def floatValue(): Float

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

22. #### def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit information
      This member is added by an implicit conversion from RichChar to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

23. #### def getClass(): Class[_ <: AnyVal]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

      a class object corresponding to the runtime type of the receiver.

    Definition Classes
      AnyVal → Any

24. #### def getDirectionality: Byte

25. #### def getNumericValue: Int

26. #### def getType: Int

27. #### def intValue(): Int

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

28. #### def isControl: Boolean

29. #### def isDigit: Boolean

30. #### def isHighSurrogate: Boolean

31. #### def isIdentifierIgnorable: Boolean

32. #### final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is `T0`.

    Test whether the dynamic type of the receiver object is `T0`.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression `1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    Definition Classes
      Any

33. #### def isLetter: Boolean

34. #### def isLetterOrDigit: Boolean

35. #### def isLowSurrogate: Boolean

36. #### def isLower: Boolean

37. #### def isMirrored: Boolean

38. #### def isSpaceChar: Boolean

39. #### def isSurrogate: Boolean

40. #### def isTitleCase: Boolean

41. #### def isUnicodeIdentifierPart: Boolean

42. #### def isUnicodeIdentifierStart: Boolean

43. #### def isUpper: Boolean

44. #### def isValidByte: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      ScalaNumericAnyConversions

45. #### def isValidChar: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      ScalaNumericAnyConversions

46. #### def isValidInt: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      ScalaNumericAnyConversions

47. #### def isValidShort: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      ScalaNumericAnyConversions

48. #### def isWhitespace: Boolean

49. #### def isWhole(): Boolean

    Definition Classes
      ScalaWholeNumberProxy → ScalaNumericAnyConversions

50. #### def longValue(): Long

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

51. #### def max(that: Char): Char

    Definition Classes
      ScalaNumberProxy

52. #### def min(that: Char): Char

    Definition Classes
      ScalaNumberProxy

53. #### def num: CharIsIntegral.type

    Attributes
      protected
    Definition Classes
      RichChar → IntegralProxy → ScalaNumberProxy

54. #### def ord: math.Ordering.Char.type

    Attributes
      protected
    Definition Classes
      RichChar → OrderedProxy

55. #### def reverseBytes: Char

56. #### val self: Char

    Definition Classes
      RichChar → Typed → Proxy

57. #### def shortValue(): Short

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

58. #### def signum: Int

    Definition Classes
      ScalaNumberProxy

59. #### def to(end: Char, step: Char): Inclusive[Char]

    Definition Classes
      IntegralProxy → RangedProxy

60. #### def to(end: Char): Inclusive[Char]

    Definition Classes
      IntegralProxy → RangedProxy

61. #### def toByte: Byte

    Returns the value of this as a scala.Byte.

    Returns the value of this as a scala.Byte. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

62. #### def toChar: Char

    Returns the value of this as a scala.Char.

    Returns the value of this as a scala.Char. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

63. #### def toDouble: Double

    Returns the value of this as a scala.Double.

    Returns the value of this as a scala.Double. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

64. #### def toFloat: Float

    Returns the value of this as a scala.Float.

    Returns the value of this as a scala.Float. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

65. #### def toInt: Int

    Returns the value of this as an scala.Int.

    Returns the value of this as an scala.Int. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

66. #### def toLong: Long

    Returns the value of this as a scala.Long.

    Returns the value of this as a scala.Long. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

67. #### def toLower: Char

68. #### def toShort: Short

    Returns the value of this as a scala.Short.

    Returns the value of this as a scala.Short. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions

69. #### def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    Definition Classes
      Proxy → Any

70. #### def toTitleCase: Char

71. #### def toUpper: Char

72. #### def underlying(): AnyRef

    Definition Classes
      ScalaNumberProxy → ScalaNumericAnyConversions

73. #### def unifiedPrimitiveEquals(x: Any): Boolean

    Should only be called after all known non-primitive types have been excluded.

    Should only be called after all known non-primitive types have been excluded. This method won't dispatch anywhere else after checking against the primitives to avoid infinite recursion between equals and this on unknown "Number" variants.

    Additionally, this should only be called if the numeric type is happy to be converted to Long, Float, and Double. If for instance a BigInt much larger than the Long range is sent here, it will claim equality with whatever Long is left in its lower 64 bits. Or a BigDecimal with more precision than Double can hold: same thing. There's no way given the interface available here to prevent this error.

    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions

74. #### def unifiedPrimitiveHashcode(): Int

    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions

75. #### def until(end: Char, step: Char): Exclusive[Char]

    Definition Classes
      IntegralProxy → RangedProxy

76. #### def until(end: Char): Exclusive[Char]

    Definition Classes
      IntegralProxy → RangedProxy

77. #### def →[B](y: B): (RichChar, B)

    Implicit information
      This member is added by an implicit conversion from RichChar to ArrowAssoc[RichChar] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from RichChar to StringAdd performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (richChar: StringAdd).self

   Definition Classes
     StringAdd

2. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from RichChar to StringFormat performed by method any2stringfmt in scala.Predef.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (richChar: StringFormat).self

   Definition Classes
     StringFormat

### Deprecated Value Members

1. #### def x: RichChar

   Implicit information
     This member is added by an implicit conversion from RichChar to ArrowAssoc[RichChar] performed by method any2ArrowAssoc in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (richChar: ArrowAssoc[RichChar]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: RichChar

   Implicit information
     This member is added by an implicit conversion from RichChar to Ensuring[RichChar] performed by method any2Ensuring in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (richChar: Ensuring[RichChar]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from IntegralProxy[Char]

### Inherited from RangedProxy[Char]

### Inherited from ScalaWholeNumberProxy[Char]

### Inherited from ScalaNumberProxy[Char]

### Inherited from OrderedProxy[Char]

### Inherited from math.Ordered[Char]

### Inherited from Comparable[Char]

### Inherited from Typed[Char]

### Inherited from Proxy

### Inherited from ScalaNumericAnyConversions

### Inherited from AnyVal

### Inherited from NotNull

### Inherited from Any

### Inherited by implicit conversion any2stringadd from RichChar to StringAdd

### Inherited by implicit conversion any2stringfmt from RichChar to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from RichChar to ArrowAssoc[RichChar]

### Inherited by implicit conversion any2Ensuring from RichChar to Ensuring[RichChar]

### Ungrouped