W3cubDocs

/Kotlin

equals

Platform and version requirements: JVM (1.0), JS (1.1)
fun String?.equals(
    other: String?, 
    ignoreCase: Boolean = false
): Boolean
Platform and version requirements: Native (1.3)
fun String?.equals(
    other: String?, 
    ignoreCase: Boolean
): Boolean

Returns true if this string is equal to other, optionally ignoring character case.

Parameters

ignoreCase - true to ignore character case when comparing strings. By default false.

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)
fun Char.equals(
    other: Char, 
    ignoreCase: Boolean = false
): Boolean

Returns true if this character is equal to the other character, optionally ignoring character case.

import kotlin.test.*
import java.util.*

fun main(args: Array<String>) {
//sampleStart
println("'a'.equals('a', false) is ${'a'.equals('a', false)}") // true
println("'a'.equals('A', false) is ${'a'.equals('A', false)}") // false
println("'a'.equals('A', true) is ${'a'.equals('A', true)}") // true
//sampleEnd
}

Parameters

ignoreCase -

true to ignore character case when comparing characters. By default false.

Two characters are considered the same ignoring case if at least one of the following is true:

  • The two characters are the same (as compared by the == operator)
  • Applying the method toUpperCase to each character produces the same result
  • Applying the method toLowerCase to each character produces the same result

© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/equals.html