Added in API level 1

Destroyable

interface Destroyable
javax.security.auth.Destroyable

Objects such as credentials may optionally implement this interface to provide the capability to destroy its contents.

Summary

Public methods
open Unit

Destroy this Object.

open Boolean

Determine if this Object has been destroyed.

Public methods

destroy

Added in API level 1
open fun destroy(): Unit

Destroy this Object.

Sensitive information associated with this Object is destroyed or cleared. Subsequent calls to certain methods on this Object will result in an IllegalStateException being thrown.

The default implementation throws DestroyFailedException.

Android note: Up to and including API 25 this method did not have a default implementation. Implementations of this interface must provide a concrete implementation of this method in order to work on older versions of Android.

Exceptions
javax.security.auth.DestroyFailedException if the destroy operation fails.

java.lang.SecurityException if the caller does not have permission to destroy this Object.

isDestroyed

Added in API level 1
open fun isDestroyed(): Boolean

Determine if this Object has been destroyed.

The default implementation returns false.

Android note: Up to and including API 25 this method did not have a default implementation. Implementations of this interface must provide a concrete implementation of this method in order to work on older versions of Android.

Return
Boolean true if this Object has been destroyed, false otherwise.