Package org.opengrok.indexer.analysis

Class Definitions

java.lang.Object

org.opengrok.indexer.analysis.Definitions

All Implemented Interfaces:

Serializable

public class Definitions
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Definitions.LineTagMap
static class	Definitions.Tag	Class that represents a single tag.

Constructor Summary

Constructors

Constructor	Description
Definitions()

Method Summary

Modifier and Type	Method	Description
void	addTag(int line, String symbol, String type, String text, int lineStart, int lineEnd)
void	addTag(int line, String symbol, String type, String text, String namespace, String signature, int lineStart, int lineEnd)
static Definitions	deserialize(byte[] bytes)	De-serialize a binary representation of a Definitions object.
Set<String>	getSymbols()	Get all symbols used in definitions.
List<Definitions.Tag>	getTags()	Get a list of all tags.
@Nullable List<Definitions.Tag>	getTags(int line)	Get a list of all tags on given line.
boolean	hasDefinitionAt(String symbol, int lineNumber, String[] strs)	Check whether the specified symbol is defined on the given line.
boolean	hasSymbol(String symbol)	Check if there is a tag for a symbol.
int	numberOfSymbols()	Return the number of distinct symbols.
int	occurrences(String symbol)	Return the number of occurrences of definitions with the specified symbol.
void	resetUnused()	Reset all Definitions.Tag.used values to false.
byte[]	serialize()	Create a binary representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Details

Definitions

public Definitions()

Method Details

resetUnused

public void resetUnused()

Reset all Definitions.Tag.used values to false.

getSymbols

public Set<String> getSymbols()

Get all symbols used in definitions.

Returns:

a set containing all the symbols

hasSymbol

public boolean hasSymbol(String symbol)

Check if there is a tag for a symbol.

Parameters:

symbol - the symbol to check

Returns:

true if there is a tag for symbol

hasDefinitionAt

public boolean hasDefinitionAt(String symbol,
 int lineNumber,
 String[] strs)

Check whether the specified symbol is defined on the given line.

Parameters:

symbol - the symbol to look for

lineNumber - the line to check

strs - type of definition(to be passed back to caller)

Returns:

true if symbol is defined on the specified line

occurrences

public int occurrences(String symbol)

Return the number of occurrences of definitions with the specified symbol.

Parameters:

symbol - the symbol to count the occurrences of

Returns:

the number of times the specified symbol is defined

numberOfSymbols

public int numberOfSymbols()

Return the number of distinct symbols.

Returns:

number of distinct symbols

getTags

public List<Definitions.Tag> getTags()

Get a list of all tags.

Returns:

all tags

getTags

@Nullable
public @Nullable List<Definitions.Tag> getTags(int line)

Get a list of all tags on given line.

Parameters:

line - line number

Returns:

list of tags or null

addTag

public void addTag(int line,
 String symbol,
 String type,
 String text,
 int lineStart,
 int lineEnd)

addTag

public void addTag(int line,
 String symbol,
 String type,
 String text,
 String namespace,
 String signature,
 int lineStart,
 int lineEnd)

serialize

public byte[] serialize()
                 throws IOException

Create a binary representation of this object.

Returns:

a byte array representing this object

Throws:

IOException - if an error happens when writing to the array

deserialize

public static Definitions deserialize(byte[] bytes)
                               throws IOException,
ClassNotFoundException

De-serialize a binary representation of a Definitions object.

Parameters:

bytes - a byte array containing the Definitions object

Returns:

a Definitions object

Throws:

IOException - if an I/O error happens when reading the array

ClassNotFoundException - if the class definition for an object stored in the byte array cannot be found

ClassCastException - if the array contains an object of another type than Definitions