Interface TermAttribute
-
- All Superinterfaces:
Attribute
- All Known Implementing Classes:
CharTermAttributeImpl
,TermAttributeImpl
,Token
@Deprecated public interface TermAttribute extends Attribute
Deprecated.UseCharTermAttribute
instead.The term text of a Token.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description char[]
resizeTermBuffer(int newSize)
Deprecated.Grows the termBuffer to at least size newSize, preserving the existing content.void
setTermBuffer(char[] buffer, int offset, int length)
Deprecated.Copies the contents of buffer, starting at offset for length characters, into the termBuffer array.void
setTermBuffer(String buffer)
Deprecated.Copies the contents of buffer into the termBuffer array.void
setTermBuffer(String buffer, int offset, int length)
Deprecated.Copies the contents of buffer, starting at offset and continuing for length characters, into the termBuffer array.void
setTermLength(int length)
Deprecated.Set number of valid characters (length of the term) in the termBuffer array.String
term()
Deprecated.Returns the Token's term text.char[]
termBuffer()
Deprecated.Returns the internal termBuffer character array which you can then directly alter.int
termLength()
Deprecated.Return number of valid characters (length of the term) in the termBuffer array.
-
-
-
Method Detail
-
term
String term()
Deprecated.Returns the Token's term text. This method has a performance penalty because the text is stored internally in a char[]. If possible, usetermBuffer()
andtermLength()
directly instead. If you really need a String, use this method, which is nothing more than a convenience call to new String(token.termBuffer(), 0, token.termLength())
-
setTermBuffer
void setTermBuffer(char[] buffer, int offset, int length)
Deprecated.Copies the contents of buffer, starting at offset for length characters, into the termBuffer array.- Parameters:
buffer
- the buffer to copyoffset
- the index in the buffer of the first character to copylength
- the number of characters to copy
-
setTermBuffer
void setTermBuffer(String buffer)
Deprecated.Copies the contents of buffer into the termBuffer array.- Parameters:
buffer
- the buffer to copy
-
setTermBuffer
void setTermBuffer(String buffer, int offset, int length)
Deprecated.Copies the contents of buffer, starting at offset and continuing for length characters, into the termBuffer array.- Parameters:
buffer
- the buffer to copyoffset
- the index in the buffer of the first character to copylength
- the number of characters to copy
-
termBuffer
char[] termBuffer()
Deprecated.Returns the internal termBuffer character array which you can then directly alter. If the array is too small for your token, useresizeTermBuffer(int)
to increase it. After altering the buffer be sure to callsetTermLength(int)
to record the number of valid characters that were placed into the termBuffer.
-
resizeTermBuffer
char[] resizeTermBuffer(int newSize)
Deprecated.Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next operation is to change the contents of the term buffer usesetTermBuffer(char[], int, int)
,setTermBuffer(String)
, orsetTermBuffer(String, int, int)
to optimally combine the resize with the setting of the termBuffer.- Parameters:
newSize
- minimum size of the new termBuffer- Returns:
- newly created termBuffer with length >= newSize
-
termLength
int termLength()
Deprecated.Return number of valid characters (length of the term) in the termBuffer array.
-
setTermLength
void setTermLength(int length)
Deprecated.Set number of valid characters (length of the term) in the termBuffer array. Use this to truncate the termBuffer or to synchronize with external manipulation of the termBuffer. Note: to grow the size of the array, useresizeTermBuffer(int)
first.- Parameters:
length
- the truncated length
-
-