com.starbase.starteam
Interface Keyword

All Known Implementing Classes:

SimpleKeyword

public interface Keyword

A Keyword object that encapsulates information about a File keyword. When a file is added, checked-in or checked-out of the repository keyword expansion may be applied to the contents of the file. For example, an occurance of $Author$ in a file might be be replaced with $Author: Fred$ upon checkout.

See Also:

KeywordReader

Method Summary

java.lang.String	expand(java.lang.String linePrefix, java.lang.String eol, boolean expand) Returns the expanded or unexpanded version of this keyword.
java.lang.String	getName() Return the keyword name.
java.lang.String	getValue() Return the keyword value.
boolean	matches(java.lang.String line, int start, int[] endPos) Returns true of this keyword is found in the specified line.
boolean	multiLine() Returns true if this keyword spans multiple lines.
boolean	stopExpanding() Return true if upon encountering this keyword in a file that no further keyword expansion will occur.
java.lang.String	toXMLString() Returns an XML representation of the keyword.

Method Detail

getName

public java.lang.String getName()

Return the keyword name.

Returns:

the keyword name.

getValue

public java.lang.String getValue()

Return the keyword value.

Returns:

the keyword value

stopExpanding

public boolean stopExpanding()

Return true if upon encountering this keyword in a file that no further keyword expansion will occur. This is true for the StarTeam keyword $NoKeywords$.

Returns:

true if keyword expansion should stop in a file after encountering this keyword.

multiLine

public boolean multiLine()

Returns true if this keyword spans multiple lines. This is only true for the StarTeam $Log$ keyword.

Returns:

true if this keyword spands multiple lines.

matches

public boolean matches(java.lang.String line,
                       int start,
                       int[] endPos)

Returns true of this keyword is found in the specified line. If found then the endPos parameter is treated as an output parameter and the value of endPos[0] should be the position in the line where the ending $ occurs.

Parameters:

line - the line to search for this keyword

start - the position in the line (zero based) to start searching

endPos - and "output" array where the end of the keyword occurs.

Returns:

true if the keyword is found on the specified line

expand

public java.lang.String expand(java.lang.String linePrefix,
                               java.lang.String eol,
                               boolean expand)

Returns the expanded or unexpanded version of this keyword. For example, if the keyword is "Author" then expanding this should return "Author: Fred$". Note that the leading $ is not returned, it is handled elsehwere. Unexpand would return "Author$"

Parameters:

linePrefix - the begining of the line in the souce leading up to the keyword

eol - the end-of-line convention used in the source file

expand - true if the keyword is to be expanded and false for unexpand

Returns:

the appropriately expanded or unexpanded keyword.

toXMLString

public java.lang.String toXMLString()

Returns an XML representation of the keyword.

Returns:

an XML representation of the keyword.