wt.fc.collections
Interface ReferenceBased

All Known Implementing Classes:

AbstractWTCollection, EmptyCollections.EmptyCollection, SynchronizedCollections.SynchronizedWTCollection, UnmodifiableCollections.UnmodifiableCollection, WTKeyedHashMap.KeySet

public interface ReferenceBased

Used by the default implementations of WTCollection to connect to other WTCollections. Non-default implementations of the WTCollection interface can implement this interface to allow themselves to be connected with default collections implementations.

Also used by the default inflate implementation.

Supported API: true

Extendable: false

Method Summary

WTReference	getReference(Persistable p) Get a reference used internally by this collection that refers to the given Persistable.
WTReference	getReference(QueryKey q) Get a reference used internally by this collection that refers to the given key.
WTReference	getReference(WTReference r) Get a reference used internally by this collection that refers to the same object as the given reference.
WTReference[]	getReferences(WTReference r) Get all the references used internally by this collection that refers to the given reference.

Method Detail

getReference

public WTReference getReference(Persistable p)

Get a reference used internally by this collection that refers to the given Persistable. If there is more than one matching reference, then the particular reference that is returned is arbitrary

Supported API: false

Parameters:

p -

Returns:

WTReference

getReference

public WTReference getReference(QueryKey q)

Get a reference used internally by this collection that refers to the given key. If there is more than one matching reference, then the particular reference that is returned is arbitrary

Supported API: false

Parameters:

q -

Returns:

WTReference

getReference

public WTReference getReference(WTReference r)

Get a reference used internally by this collection that refers to the same object as the given reference. If there is more than one matching reference, then the particular reference that is returned is arbitrary

Supported API: false

Parameters:

r -

Returns:

WTReference

getReferences

public WTReference[] getReferences(WTReference r)

Get all the references used internally by this collection that refers to the given reference. This is used by the default implementation of inflate.

Supported API: false

Parameters:

r -

Returns:

WTReference[]