Pointer (Terrier Information Retrieval Platform 5.5 API)

All Known Subinterfaces:

BitIndexPointer, MemoryPointer

All Known Implementing Classes:

BasicDocumentIndexEntry, BasicLexiconEntry, BasicTermStatsLexiconEntry, DocumentIndexEntry, FieldDocumentIndexEntry, FieldLexiconEntry, LexiconEntry, MemoryFieldsLexiconEntry, MemoryLexiconEntry, MultiDocumentEntry, MultiLexiconEntry, NonIncrementalDocumentIndexEntry, SimpleBitIndexPointer, SimpleDocumentIndexEntry, Tr3BlockFieldLexiconEntry, Tr3BlockLexiconEntry, Tr4BasicLexiconEntry, Tr4BasicTermStatsLexiconEntry, Tr4FieldLexiconEntry
```
public interface Pointer
```
A base interface for all pointers. A pointer is a "counter" of "things".

Since:

3.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`getNumberOfEntries()`	Return the number of "things" that this pointer refers to.
`java.lang.String`	`pointerToString()`	Deprecated.
`void`	`setNumberOfEntries(int n)`	Set the number of "things" that the pointer refers to.
`void`	`setPointer(Pointer p)`	Sets the pointer within this object to that represented by the specified pointer.

- Method Detail
  - getNumberOfEntries
```
int getNumberOfEntries()
```
    Return the number of "things" that this pointer refers to.
    
    Returns:
    
    the number of "things" that this pointer refers to.
  - setNumberOfEntries
```
void setNumberOfEntries(int n)
```
    Set the number of "things" that the pointer refers to.
    
    Parameters:
    
    n - the number of "things" that the pointer refers to.
  - pointerToString
```
@Deprecated
java.lang.String pointerToString()
```
    Deprecated.
    
    Returns a textual representation of the pointer alone
  - setPointer
```
void setPointer(Pointer p)
```
    Sets the pointer within this object to that represented by the specified pointer.
    
    Parameters:
    
    p - other pointer to update the pointer in this object.