Stay organized with collections
Save and categorize content based on your preferences.
GuardedObject
open class GuardedObject : Serializable
A GuardedObject is an object that is used to protect access to another object.
A GuardedObject encapsulates a target object and a Guard object, such that access to the target object is possible only if the Guard object allows it. Once an object is encapsulated by a GuardedObject, access to that object is controlled by the getObject method, which invokes the checkGuard method on the Guard object that is guarding access. If access is not allowed, an exception is thrown.
Summary
| Public constructors |
|
Constructs a GuardedObject using the specified object and guard.
|
| Public methods |
| open Any! |
Retrieves the guarded object, or throws an exception if access to the guarded object is denied by the guard.
|
Public constructors
GuardedObject
GuardedObject(
object: Any!,
guard: Guard!)
Constructs a GuardedObject using the specified object and guard. If the Guard object is null, then no restrictions will be placed on who can access the object.
| Parameters |
object |
Any!: the object to be guarded. |
guard |
Guard!: the Guard object that guards access to the object. |
Public methods
getObject
open fun getObject(): Any!
Retrieves the guarded object, or throws an exception if access to the guarded object is denied by the guard.
| Return |
Any! |
the guarded object. |
| Exceptions |
java.lang.SecurityException |
if access to the guarded object is denied. |
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,["# GuardedObject\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nGuardedObject\n=============\n\n```\nopen class GuardedObject : Serializable\n```\n\n|---|----------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.security.GuardedObject](#) |\n\nA GuardedObject is an object that is used to protect access to another object.\n\nA GuardedObject encapsulates a target object and a Guard object, such that access to the target object is possible only if the Guard object allows it. Once an object is encapsulated by a GuardedObject, access to that object is controlled by the `getObject` method, which invokes the `checkGuard` method on the Guard object that is guarding access. If access is not allowed, an exception is thrown.\n\nSummary\n-------\n\n| Public constructors ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [GuardedObject](#GuardedObject(kotlin.Any,%20java.security.Guard))`(`object:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!`, `guard:` `[Guard](/reference/kotlin/java/security/Guard)!`)` Constructs a GuardedObject using the specified object and guard. |\n\n| Public methods ||\n|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| open [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | [getObject](#getObject())`()` Retrieves the guarded object, or throws an exception if access to the guarded object is denied by the guard. |\n\nPublic constructors\n-------------------\n\n### GuardedObject\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nGuardedObject(\n object: Any!, \n guard: Guard!)\n```\n\nConstructs a GuardedObject using the specified object and guard. If the Guard object is null, then no restrictions will be placed on who can access the object.\n\n| Parameters ||\n|----------|--------------------------------------------------------------------------------------------------------|\n| `object` | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!: the object to be guarded. |\n| `guard` | [Guard](/reference/kotlin/java/security/Guard)!: the Guard object that guards access to the object. |\n\nPublic methods\n--------------\n\n### getObject\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getObject(): Any!\n```\n\nRetrieves the guarded object, or throws an exception if access to the guarded object is denied by the guard.\n\n| Return ||\n|-----------------------------------------------------------------------------|---------------------|\n| [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | the guarded object. |\n\n| Exceptions ||\n|-------------------------------|--------------------------------------------|\n| `java.lang.SecurityException` | if access to the guarded object is denied. |"]]
