MemberReference (Jikes RVM API)

java.lang.Object
- org.jikesrvm.classloader.MemberReference

Direct Known Subclasses:

FieldReference, MethodReference
```
public abstract class MemberReference
extends Object
```
A class to represent the reference in a class file to some member (field or method). A member reference is uniquely defined by
- a type reference
- a method name
- a descriptor
Resolving a MemberReference to a RVMMember can be an expensive operation. Therefore we canonicalize MemberReference instances and cache the result of resolution.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Atom`	`descriptor` The descriptor
`private static ImmutableEntryHashSetRVM<MemberReference>`	`dictionary` Used to canonicalize memberReferences
`protected int`	`id` Unique id for the member reference (ignored in .equals comparison)
`private static int`	`LOG_ROW_SIZE` 2^LOG_ROW_SIZE is the number of elements per row
`private static MemberReference[][]`	`members` Dictionary of all MemberReference instances.
`protected Atom`	`name` The member name
`private static int`	`nextId` Used to assign ids.
`private static int`	`ROW_MASK` Mask to ascertain row from id number
`protected TypeReference`	`type` The type reference

Constructor Summary

Constructors
Modifier Constructor and Description

protected MemberReference(TypeReference tRef, Atom mn, Atom d, int id)

Constructors
Modifier	Constructor and Description
`protected`	`MemberReference(TypeReference tRef, Atom mn, Atom d, int id)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldReference`	`asFieldReference()`
`MethodReference`	`asMethodReference()`
`boolean`	`equals(Object other)`
`static MemberReference`	`findOrCreate(TypeReference tRef, Atom mn, Atom md)` Find or create the canonical MemberReference instance for the given tuple.
`Atom`	`getDescriptor()`
`static FieldReference`	`getFieldRef(int id)`
`int`	`getId()`
`static MemberReference`	`getMemberRef(int id)`
`static MethodReference`	`getMethodRef(int id)`
`Atom`	`getName()`
`static int`	`getNextId()`
`TypeReference`	`getType()`
`int`	`hashCode()`
`boolean`	`isFieldReference()`
`boolean`	`isMethodReference()`
`boolean`	`needsDynamicLink(RVMMethod that)` Is dynamic linking code required to access "this" member when referenced from "that" method?
`static MemberReference`	`parse(StringTokenizer parser)` Given a StringTokenizer currently pointing to the start of a `MemberReference` (created by doing a toString() on a MemberReference), parse it and find/create the appropriate MemberReference.
`static MemberReference`	`parse(StringTokenizer parser, boolean boot)`
`RVMMember`	`peekResolvedMember()`
`RVMMember`	`resolveMember()` Forces resolution and returns the resolved member.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - dictionary
```
private static final ImmutableEntryHashSetRVM<MemberReference> dictionary
```
    Used to canonicalize memberReferences
  - LOG_ROW_SIZE
```
private static final int LOG_ROW_SIZE
```
    2^LOG_ROW_SIZE is the number of elements per row
    
    See Also:
    
    Constant Field Values
  - ROW_MASK
```
private static final int ROW_MASK
```
    Mask to ascertain row from id number
    
    See Also:
    
    Constant Field Values
  - members
```
private static MemberReference[][] members
```
    Dictionary of all MemberReference instances.
  - nextId
```
private static int nextId
```
    Used to assign ids. Id 0 is not used to support usage of member reference id's in JNI.
  - id
```
protected final int id
```
    Unique id for the member reference (ignored in .equals comparison)
  - type
```
protected final TypeReference type
```
    The type reference
  - name
```
protected final Atom name
```
    The member name
  - descriptor
```
protected final Atom descriptor
```
    The descriptor
- Constructor Detail
  - MemberReference
```
protected MemberReference(TypeReference tRef,
                          Atom mn,
                          Atom d,
                          int id)
```
    Parameters:
    
    tRef - the type reference
    
    mn - the field or method name
    
    d - the field or method descriptor
    
    id - the new ID of the member were a new member required (ignored in .equals test)
- Method Detail
  - findOrCreate
```
public static MemberReference findOrCreate(TypeReference tRef,
                                           Atom mn,
                                           Atom md)
```
    Find or create the canonical MemberReference instance for the given tuple.
    
    Parameters:
    
    tRef - the type reference
    
    mn - the name of the member
    
    md - the descriptor of the member
    
    Returns:
    
    a member reference, never null
  - parse
```
public static MemberReference parse(StringTokenizer parser)
```
    Given a StringTokenizer currently pointing to the start of a MemberReference (created by doing a toString() on a MemberReference), parse it and find/create the appropriate MemberReference. Consumes all of the tokens corresponding to the member reference.
    
    Parameters:
    
    parser - a parser that fulfills the conditions described above
    
    Returns:
    
    a member reference or null if parsing fails
  - parse
```
public static MemberReference parse(StringTokenizer parser,
                                    boolean boot)
```
  - getNextId
```
public static int getNextId()
```
  - getMemberRef
```
public static MemberReference getMemberRef(int id)
```
  - getMethodRef
```
public static MethodReference getMethodRef(int id)
```
  - getFieldRef
```
public static FieldReference getFieldRef(int id)
```
  - getType
```
public final TypeReference getType()
```
    Returns:
    
    the type reference component of this member reference
  - getName
```
public final Atom getName()
```
    Returns:
    
    the member name component of this member reference
  - getDescriptor
```
public final Atom getDescriptor()
```
    Returns:
    
    the descriptor component of this member reference
  - getId
```
public final int getId()
```
    Returns:
    
    the dynamic linking id to use for this member.
  - isFieldReference
```
public final boolean isFieldReference()
```
    Returns:
    
    true if this member references a field
  - isMethodReference
```
public final boolean isMethodReference()
```
    Returns:
    
    true if this member references a method
  - asFieldReference
```
public final FieldReference asFieldReference()
```
    Returns:
    
    this cast to a FieldReference
  - asMethodReference
```
public final MethodReference asMethodReference()
```
    Returns:
    
    this cast to a MethodReference
  - peekResolvedMember
```
public final RVMMember peekResolvedMember()
```
    Returns:
    
    the RVMMember this reference resolves to if it is already known or null if it cannot be resolved without risking class loading.
  - resolveMember
```
public final RVMMember resolveMember()
```
    Forces resolution and returns the resolved member. Will cause classloading if necessary.
    
    Returns:
    
    the resolved member
  - needsDynamicLink
```
public final boolean needsDynamicLink(RVMMethod that)
```
    Is dynamic linking code required to access "this" member when referenced from "that" method?
    This method is conservative, i.e. it will answer that we need linking if we don't know if it will be necessary.
    
    Parameters:
    
    that - the method to access
    
    Returns:
    
    true if dynamic linking could be necessary
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class MemberReference

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dictionary

LOG_ROW_SIZE

ROW_MASK

members

nextId

id

type

name

descriptor

Constructor Detail

MemberReference

Method Detail

findOrCreate

parse

parse

getNextId

getMemberRef

getMethodRef

getFieldRef

getType

getName

getDescriptor

getId

isFieldReference

isMethodReference

asFieldReference

asMethodReference

peekResolvedMember

resolveMember

needsDynamicLink

hashCode

equals

toString