OpenJDK 1.22 · java.security.GuardedObject · APIdia, the JavaDoc alternative

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.

Field Summary

Modifier and Type	Field and Description
private final Guard	guard The guard object.
private final Object	object The object we are guarding.
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	GuardedObject(Object the object to be guarded. object, Guard the Guard object that guards access to the object. guard) Constructs a GuardedObject using the specified object and guard.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: the guarded object. getObject() Retrieves the guarded object, or throws an exception if access to the guarded object is denied by the guard.
private void	writeObject(ObjectOutputStream the `ObjectOutputStream` to which data is written oos) Writes this object out to a stream (i.e., serializes it).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

guard	back to summary
private final Guard guard The guard object. Annotations @SuppressWarnings:serial

object	back to summary
private final Object object The object we are guarding. Annotations @SuppressWarnings:serial

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

Constructor Detail

GuardedObject back to summary

GuardedObject	back to summary
public GuardedObject(Object object, 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:Object the object to be guarded. guard:Guard the Guard object that guards access to the object.

public GuardedObject(Object object, 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:Object: the object to be guarded.
guard:Guard: the Guard object that guards access to the object.

Method Detail

getObject	back to summary
public Object getObject() throws SecurityException Retrieves the guarded object, or throws an exception if access to the guarded object is denied by the guard. Returns:Object the guarded object. Exceptions SecurityException: if access to the guarded object is denied.

getObject

back to summary

public Object getObject() throws SecurityException

Retrieves the guarded object, or throws an exception if access to the guarded object is denied by the guard.

Returns:Object

the guarded object.

Exceptions

SecurityException:: if access to the guarded object is denied.

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream oos) throws IOException Writes this object out to a stream (i.e., serializes it). We check the guard if there is one. Parameters oos:ObjectOutputStream the `ObjectOutputStream` to which data is written Annotations @Serial Exceptions IOException: if an I/O error occurs

private void writeObject(ObjectOutputStream oos) throws IOException

Writes this object out to a stream (i.e., serializes it). We check the guard if there is one.