Stay organized with collections
Save and categorize content based on your preferences.
CRC32
open class CRC32 : Checksum
A class that can be used to compute the CRC-32 of a data stream.
Passing a null argument to a method in this class will cause a NullPointerException to be thrown.
Summary
| Public constructors |
|
Creates a new CRC32 object.
|
| Public methods |
| open Long |
Returns CRC-32 value.
|
| open Unit |
Resets CRC-32 to initial value.
|
| open Unit |
Updates the CRC-32 checksum with the specified array of bytes.
|
| open Unit |
Updates the CRC-32 checksum with the specified array of bytes.
|
| open Unit |
Updates the CRC-32 checksum with the specified byte (the low eight bits of the argument b).
|
| open Unit |
Updates the CRC-32 checksum with the bytes from the specified buffer.
|
Public constructors
CRC32
CRC32()
Creates a new CRC32 object.
Public methods
getValue
open fun getValue(): Long
Returns CRC-32 value.
| Return |
Long |
the current checksum value |
reset
open fun reset(): Unit
Resets CRC-32 to initial value.
update
open fun update(b: ByteArray!): Unit
Updates the CRC-32 checksum with the specified array of bytes.
| Parameters |
b |
ByteArray!: the array of bytes to update the checksum with |
| Exceptions |
java.lang.NullPointerException |
if b is null |
update
open fun update(
b: ByteArray!,
off: Int,
len: Int
): Unit
Updates the CRC-32 checksum with the specified array of bytes.
| Parameters |
b |
ByteArray!: the byte array to update the checksum with |
off |
Int: the start offset of the data |
len |
Int: the number of bytes to use for the update |
| Exceptions |
java.lang.ArrayIndexOutOfBoundsException |
if off is negative, or len is negative, or off+len is negative or greater than the length of the array b. |
update
open fun update(b: Int): Unit
Updates the CRC-32 checksum with the specified byte (the low eight bits of the argument b).
| Parameters |
b |
Int: the byte to update the checksum with |
update
open fun update(buffer: ByteBuffer!): Unit
Updates the CRC-32 checksum with the bytes from the specified buffer. The checksum is updated with the remaining bytes in the buffer, starting at the buffer's position. Upon return, the buffer's position will be updated to its limit; its limit will not have been changed.
| Parameters |
buffer |
ByteBuffer!: the ByteBuffer to update the checksum with |
| Exceptions |
java.lang.NullPointerException |
if buffer is null |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# CRC32\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nCRC32\n=====\n\n```\nopen class CRC32 : Checksum\n```\n\n|---|--------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.util.zip.CRC32](#) |\n\nA class that can be used to compute the CRC-32 of a data stream.\n\nPassing a `null` argument to a method in this class will cause a [NullPointerException](../../lang/NullPointerException.html#) to be thrown.\n\nSummary\n-------\n\n| Public constructors ||\n|---------------------------------------------------|---|\n| [CRC32](#CRC32())`()` Creates a new CRC32 object. |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [getValue](#getValue())`()` Returns CRC-32 value. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [reset](#reset())`()` Resets CRC-32 to initial value. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [update](#update(kotlin.ByteArray))`(`b:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!`)` Updates the CRC-32 checksum with the specified array of bytes. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [update](#update(kotlin.ByteArray,%20kotlin.Int,%20kotlin.Int))`(`b:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!`, `off:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `len:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Updates the CRC-32 checksum with the specified array of bytes. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [update](#update(kotlin.Int))`(`b:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Updates the CRC-32 checksum with the specified byte (the low eight bits of the argument b). |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [update](#update(java.nio.ByteBuffer))`(`buffer:` `[ByteBuffer](../../nio/ByteBuffer.html#)!`)` Updates the CRC-32 checksum with the bytes from the specified buffer. |\n\nPublic constructors\n-------------------\n\n### CRC32\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nCRC32()\n```\n\nCreates a new CRC32 object.\n\nPublic methods\n--------------\n\n### getValue\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getValue(): Long\n```\n\nReturns CRC-32 value.\n\n| Return ||\n|------------------------------------------------------------------------------|----------------------------|\n| [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | the current checksum value |\n\n### reset\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun reset(): Unit\n```\n\nResets CRC-32 to initial value. \n\n### update\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun update(b: ByteArray!): Unit\n```\n\nUpdates the CRC-32 checksum with the specified array of bytes.\n\n| Parameters ||\n|-----|------------------------------------------------------------------------------------------------------------------------------------------|\n| `b` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!: the array of bytes to update the checksum with |\n\n| Exceptions ||\n|----------------------------------|------------------|\n| `java.lang.NullPointerException` | if `b` is `null` |\n\n### update\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun update(\n b: ByteArray!, \n off: Int, \n len: Int\n): Unit\n```\n\nUpdates the CRC-32 checksum with the specified array of bytes.\n\n| Parameters ||\n|-------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `b` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)!: the byte array to update the checksum with |\n| `off` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the start offset of the data |\n| `len` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the number of bytes to use for the update |\n\n| Exceptions ||\n|--------------------------------------------|-------------------------------------------------------------------------------------------------------------------|\n| `java.lang.ArrayIndexOutOfBoundsException` | if `off` is negative, or `len` is negative, or `off+len` is negative or greater than the length of the array `b`. |\n\n### update\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun update(b: Int): Unit\n```\n\nUpdates the CRC-32 checksum with the specified byte (the low eight bits of the argument b).\n\n| Parameters ||\n|-----|------------------------------------------------------------------------------------------------------------------|\n| `b` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the byte to update the checksum with |\n\n### update\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun update(buffer: ByteBuffer!): Unit\n```\n\nUpdates the CRC-32 checksum with the bytes from the specified buffer. The checksum is updated with the remaining bytes in the buffer, starting at the buffer's position. Upon return, the buffer's position will be updated to its limit; its limit will not have been changed.\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------|\n| `buffer` | [ByteBuffer](../../nio/ByteBuffer.html#)!: the ByteBuffer to update the checksum with |\n\n| Exceptions ||\n|----------------------------------|-----------------------|\n| `java.lang.NullPointerException` | if `buffer` is `null` |"]]
