org.fife.ctags
Class TagEntry

java.lang.Object
  org.fife.ctags.TagEntry

public class TagEntry

extends java.lang.Object

Simple class that contains information about a specific tag. This class is public domain.

Version:

0.1

Author:

Robert Futrell

Field Summary

java.util.ArrayList	fieldList List of key-value pairs.
java.lang.String	file Path of source file containing the definition of this tag.
boolean	fileScope Whether this tag is of file-limited scope.
java.lang.String	kind Kind of tag (may be name, character, or null if not known).
long	lineNumber Line number in source file of tag definition (may be zero if not known).
java.lang.String	name The name of this tag entry.
java.lang.String	pattern Pattern for locating source line (may be null if not present).

Constructor Summary

TagEntry()
Creates a new TagEntry.

TagEntry(java.lang.String line)
Creates a new TagEntry based on the passed-in ctag file line.

Method Summary

java.lang.String	getPlainTextPattern() Returns a "plain text" version of pattern - that is, with escaped characters un-escaped, and without a leading "/^" or trailing "$/".
void	parseTagLine(java.lang.String line) Parses a line from a ctag file and populates this tag entry with appropriate values.
java.lang.String	toString() Writes this tag entry as a string.

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

The name of this tag entry.

file

public java.lang.String file

Path of source file containing the definition of this tag.

pattern

public java.lang.String pattern

Pattern for locating source line (may be null if not present).

See Also:

getPlainTextPattern()

lineNumber

public long lineNumber

Line number in source file of tag definition (may be zero if not known).

kind

public java.lang.String kind

Kind of tag (may be name, character, or null if not known).

fileScope

public boolean fileScope

Whether this tag is of file-limited scope.

fieldList

public java.util.ArrayList fieldList

List of key-value pairs.

Constructor Detail

TagEntry

public TagEntry()

Creates a new TagEntry.

TagEntry

public TagEntry(java.lang.String line)

Creates a new TagEntry based on the passed-in ctag file line.

Parameters:

line - A line from a ctag file on which to create this tag entry.

Method Detail

getPlainTextPattern

public java.lang.String getPlainTextPattern()

Returns a "plain text" version of pattern - that is, with escaped characters un-escaped, and without a leading "/^" or trailing "$/".

Returns:

pattern as plain text, or null if there is no pattern (in which case, use lineNumber).

parseTagLine

public void parseTagLine(java.lang.String line)

Parses a line from a ctag file and populates this tag entry with appropriate values.

Parameters:

line - A line from a ctag file.

toString

public java.lang.String toString()

Writes this tag entry as a string.

Returns:

A string representation of this TagEntry.