org.aspectj.org.eclipse.jdt.internal.core.nd.field

Class FieldSearchIndex<T extends NdNode>

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.nd.field.FieldSearchIndex<T>

All Implemented Interfaces:

IDestructableField, IField

public class FieldSearchIndex<T extends NdNode>
extends java.lang.Object
implements IDestructableField

Declares a field representing a case-insensitive search tree over elements which are a subtype of NdNode.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FieldSearchIndex.IResultRank
static class	FieldSearchIndex.SearchCriteria
static interface	FieldSearchIndex.Visitor<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	offset

Method Summary

Modifier and Type	Method and Description
java.util.List<T>	asList(Nd nd, long address) Returns the entire contents of the index as a single list.
static <T extends NdNode,B> FieldSearchIndex<T>	create(StructDef<B> builder, FieldSearchKey<B> searchKey)
void	destruct(Nd nd, long address)
java.util.List<T>	findAll(Nd nd, long address, FieldSearchIndex.SearchCriteria searchCriteria)
java.util.List<T>	findAll(Nd nd, long address, FieldSearchIndex.SearchCriteria searchCriteria, int count)
T	findBest(Nd nd, long address, FieldSearchIndex.SearchCriteria searchCriteria, FieldSearchIndex.IResultRank rankFunction)
T	findFirst(Nd nd, long address, FieldSearchIndex.SearchCriteria searchCriteria)
BTree	get(Nd nd, long address)
java.lang.String	getFieldName() Returns the name of the field.
int	getOffset() Returns the field offset, in bytes from the start of the struct.
int	getRecordSize() Returns the size of the field, in bytes.
protected void	setFieldName(java.lang.String fieldName)
void	setOffset(int offset) Sets the field offset (bytes from the start of the struct).
boolean	visitAll(Nd nd, long address, FieldSearchIndex.SearchCriteria searchCriteria, FieldSearchIndex.Visitor<T> visitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.core.nd.field.IField

getAlignment

Field Detail

offset

protected int offset

Method Detail

create

public static <T extends NdNode,B> FieldSearchIndex<T> create(StructDef<B> builder,
                                                              FieldSearchKey<B> searchKey)

get

public BTree get(Nd nd,
                 long address)

destruct

public void destruct(Nd nd,
                     long address)

Specified by:

destruct in interface IDestructableField

getRecordSize

public int getRecordSize()

Description copied from interface: IField

Returns the size of the field, in bytes.

Specified by:

getRecordSize in interface IField

findFirst

public T findFirst(Nd nd,
                   long address,
                   FieldSearchIndex.SearchCriteria searchCriteria)

findBest

public T findBest(Nd nd,
                  long address,
                  FieldSearchIndex.SearchCriteria searchCriteria,
                  FieldSearchIndex.IResultRank rankFunction)

visitAll

public boolean visitAll(Nd nd,
                        long address,
                        FieldSearchIndex.SearchCriteria searchCriteria,
                        FieldSearchIndex.Visitor<T> visitor)

findAll

public java.util.List<T> findAll(Nd nd,
                                 long address,
                                 FieldSearchIndex.SearchCriteria searchCriteria)

findAll

public java.util.List<T> findAll(Nd nd,
                                 long address,
                                 FieldSearchIndex.SearchCriteria searchCriteria,
                                 int count)

asList

public java.util.List<T> asList(Nd nd,
                                long address)

Returns the entire contents of the index as a single list.

setFieldName

protected final void setFieldName(java.lang.String fieldName)

setOffset

public final void setOffset(int offset)

Description copied from interface: IField

Sets the field offset (bytes from the start of the struct). This is invoked some time after field construction, after the sizes of all preceeding fields are known.

Specified by:

setOffset in interface IField

getOffset

public final int getOffset()

Description copied from interface: IField

Returns the field offset, in bytes from the start of the struct.

Specified by:

getOffset in interface IField

getFieldName

public final java.lang.String getFieldName()

Description copied from interface: IField

Returns the name of the field. This is mainly used for error messages, debug output, and diagnostic tools. Meant to be programmer-readable but not user-readable.

Specified by:

getFieldName in interface IField