de.uka.ilkd.key.util

Class ProofUserManager

java.lang.Object

de.uka.ilkd.key.util.ProofUserManager

public final class ProofUserManager
extends java.lang.Object

This singleton class is used to manage user of a Proof to make sure that a Proof is only disposed via Proof.dispose() if it is no longer in use (no user available).

Author:

Martin Hentschel

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.WeakHashMap<KeYEnvironment<?>,java.util.Set<Proof>>	environmentProofs Stores for each KeYEnvironment the known Proofs.
private static ProofUserManager	instance The only instance of this class.
private java.util.WeakHashMap<Proof,KeYEnvironment<?>>	proofEnvironments Stores for each Proof the KeYEnvironment it lives in..
private java.util.WeakHashMap<Proof,java.util.Set<java.lang.Object>>	proofUsers Stores for each Proof the registered users.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ProofUserManager() Forbid multiple instances.

Method Summary

Modifier and Type	Method and Description
void	addUser(Proof proof, KeYEnvironment<?> environment, java.lang.Object user) Registers the Proof with the given user if it is not already registered.
KeYEnvironment<?>	getEnvironment(Proof proof) Returns the known environment of the given Proof.
static ProofUserManager	getInstance() Returns the singleton instance of this class.
Proof[]	getProofs() Returns all registered Proofs.
Proof[]	getProofs(KeYEnvironment<?> environment) Returns all known Proofs of the given KeYEnvironment.
java.lang.Object[]	getUsers(Proof proof) Returns all registered user of the given Proof.
void	removeUserAndDispose(Proof proof, java.lang.Object user) Removes the user from the registered proof users.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

proofUsers

private java.util.WeakHashMap<Proof,java.util.Set<java.lang.Object>> proofUsers

Stores for each Proof the registered users.

environmentProofs

private java.util.WeakHashMap<KeYEnvironment<?>,java.util.Set<Proof>> environmentProofs

Stores for each KeYEnvironment the known Proofs.

proofEnvironments

private java.util.WeakHashMap<Proof,KeYEnvironment<?>> proofEnvironments

Stores for each Proof the KeYEnvironment it lives in..

instance

private static final ProofUserManager instance

The only instance of this class.

Constructor Detail

ProofUserManager

private ProofUserManager()

Forbid multiple instances.

Method Detail

addUser

public void addUser(Proof proof,
                    KeYEnvironment<?> environment,
                    java.lang.Object user)

Registers the Proof with the given user if it is not already registered. If it is already registered the user is added to the proof users if not already present.

Parameters:

proof - The Proof.

environment - Optional the KeYEnvironment which will be disposed if the last known Proof is removed from it.

user - The user.

removeUserAndDispose

public void removeUserAndDispose(Proof proof,
                                 java.lang.Object user)

Removes the user from the registered proof users. If the proof has no user anymore it is automatically disposed via Proof.dispose().

Parameters:

proof - The Proof.

userThe - user.

getProofs

public Proof[] getProofs()

Returns all registered Proofs.

Returns:

All registered Proofs.

getUsers

public java.lang.Object[] getUsers(Proof proof)

Returns all registered user of the given Proof.

Parameters:

proof - The Proof to get its users.

Returns:

The registered user of the Proof.

getEnvironment

public KeYEnvironment<?> getEnvironment(Proof proof)

Returns the known environment of the given Proof.

Parameters:

proof - The Proof to get its KeYEnvironment.

Returns:

The KeYEnvironment of the given Proof.

getProofs

public Proof[] getProofs(KeYEnvironment<?> environment)

Returns all known Proofs of the given KeYEnvironment.

Parameters:

environment - The known Proofs of the given KeYEnvironment.

Returns:

All known Proofs of the given KeYEnvironment.

getInstance

public static ProofUserManager getInstance()

Returns the singleton instance of this class.

Returns:

The singleton instance of this class.