org.jpc.term.refterm

Class RefTermManager

java.lang.Object

org.jpc.term.refterm.RefTermManager

public class RefTermManager
extends Object

Allows to create term a representation (referred as a 'jRefTerm') for arbitrary Java object references. These term representations may be explicitly provided by a programmer (they must be compound terms), or they may be generated under the curtains when no provided. When generated, term references have the form 'jref_term(id)', where id uniquely identifies the reference (in the current class loader).

Author:

sergioc

Field Summary

Fields

Modifier and Type	Field and Description
static String	JREF_TERM_FUNCTOR_NAME

Constructor Summary

Constructors

Constructor and Description
RefTermManager()
RefTermManager(ReferenceQueue<?> referenceQueue)

Method Summary

Modifier and Type	Method and Description
void	forgetRef(Object ref) The given reference will not be associated anymore to a term.
void	forgetRefTerm(Compound term) The given term will not be associated anymore to a reference.
MutableIndexManager	getIndexManager()
Compound	newRefTerm(Object ref) Maps an object to a generated and unique term representation.
Compound	newRefTerm(Object ref, Compound compound) Maps an object to a given term representation.
Compound	newSoftRefTerm(Object ref) Maps an object to a generated and unique term representation.
Compound	newSoftRefTerm(Object ref, Compound compound) Maps an object to a given term representation.
Compound	newWeakRefTerm(Object ref) Maps an object to a generated and unique term representation.
Compound	newWeakRefTerm(Object ref, Compound compound) Maps an object to a given term representation.
Compound	refTerm(Object ref)
Compound	refTermOrThrow(Object ref)
<T> T	resolve(Compound compound)
<T> T	resolveOrThrow(Compound compound)
static Compound	softJRefTerm(Object ref)
static Compound	weakJRefTerm(Object ref)

Methods inherited from class java.lang.Object

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

Field Detail

JREF_TERM_FUNCTOR_NAME

public static final String JREF_TERM_FUNCTOR_NAME

See Also:

Constant Field Values

Constructor Detail

RefTermManager

public RefTermManager()

RefTermManager

public RefTermManager(ReferenceQueue<?> referenceQueue)

Method Detail

weakJRefTerm

public static Compound weakJRefTerm(Object ref)

Parameters:

ref - an object to map to a term.

Returns:

a term representation of the object. A weak reference to the object is internally maintained.

softJRefTerm

public static Compound softJRefTerm(Object ref)

Parameters:

ref - an object to map to a term.

Returns:

a term representation of the object. A soft reference to the object is internally maintained.

getIndexManager

public MutableIndexManager getIndexManager()

newSoftRefTerm

public Compound newSoftRefTerm(Object ref,
                               Compound compound)

Maps an object to a given term representation. The mapping exists as long as the object is not garbage collected. The reference is internally maintained by means of a soft reference. If the object is already associated to the compound sent as parameter the method returns without errors. However, if the object or compound are already registered and associated to different objects (i.e., different to the ones in the method parameters), it will throw an exception.

Parameters:

ref - the object to identify as the term sent as second argument.

compound - the term representation of the object sent as first argument.

Returns:

the term representation of the object (the second parameter).

newSoftRefTerm

public Compound newSoftRefTerm(Object ref)

Maps an object to a generated and unique term representation. The mapping exists as long as the object is not garbage collected. The reference is internally maintained by means of a soft reference.

Parameters:

ref - the object to identify as a term reference.

Returns:

the (generated) term representation of a reference.

newWeakRefTerm

public Compound newWeakRefTerm(Object ref,
                               Compound compound)

Maps an object to a given term representation. The mapping exists as long as the object is not garbage collected. The reference is internally maintained by means of a weak reference. If the object is already associated to the compound sent as parameter the method returns without errors. However, if the object or compound are already registered and associated to different objects (i.e., different to the ones in the method parameters), it will throw an exception.

Parameters:

ref - the object to identify as the term sent as second argument.

compound - the term representation of the object sent as first argument.

Returns:

the term representation of the object (the second parameter).

newWeakRefTerm

public Compound newWeakRefTerm(Object ref)

Maps an object to a generated and unique term representation. The mapping exists as long as the object is not garbage collected. The reference is internally maintained by means of a weak reference.

Parameters:

ref - the object to identify as a term reference.

Returns:

the (generated) term representation of a reference.

newRefTerm

public Compound newRefTerm(Object ref,
                           Compound compound)

Maps an object to a given term representation. The mapping exists as long as the object is not garbage collected. The object reference is internally stored to prevent it from being garbage collected.

Parameters:

ref - the object to identify as the term sent as second argument.

compound - the term representation of the object sent as first argument.

Returns:

the term representation of the object (the second parameter).

newRefTerm

public Compound newRefTerm(Object ref)

Maps an object to a generated and unique term representation. The mapping exists as long as the object is not garbage collected. The object reference is internally stored to prevent it from being garbage collected.

Parameters:

ref - the object to identify as a term reference.

Returns:

the (generated) term representation of a reference.

forgetRefTerm

public void forgetRefTerm(Compound term)

The given term will not be associated anymore to a reference.

Parameters:

term - the term representation of a reference to forget.

forgetRef

public void forgetRef(Object ref)

The given reference will not be associated anymore to a term.

Parameters:

ref - the reference to forget.

refTerm

public Compound refTerm(Object ref)

Parameters:

ref - an object reference.

Returns:

the term representation of a given object reference. Null if the reference is not associated with a term representation.

refTermOrThrow

public Compound refTermOrThrow(Object ref)

Parameters:

ref - an object reference.

Returns:

the term representation of a given object reference.

Throws:

JpcException - if the reference is not associated with a term representation.

resolve

public <T> T resolve(Compound compound)

Parameters:

compound - a (compound) term.

Returns:

the reference associated with the given term. Null if no reference is associated with such a term.

resolveOrThrow

public <T> T resolveOrThrow(Compound compound)

Parameters:

compound - a (compound) term.

Returns:

the reference associated with the given term.

Throws:

JpcException - if no reference is associated with such a term.