|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jsieve.ScriptCoordinate
public final class ScriptCoordinate
Specifies the positional extent of an element within the script being executed. In other words, this gives the line and column at which the elment starts and at which it ends.
Constructor Summary | |
---|---|
ScriptCoordinate(int startLineNumber,
int startColumnNumber,
int endLineNumber,
int endColumnNumber)
|
Method Summary | |
---|---|
java.lang.String |
addStartLineAndColumn(java.lang.CharSequence message)
Appends a standard position phrase to the given message. |
CommandException |
commandException(java.lang.CharSequence message)
Creates a command exception based on the given message containing details of the script position. |
void |
debugDiagnostics(org.apache.commons.logging.Log logger)
Logs diagnotic information about the script coordinate. |
int |
getEndColumnNumber()
Gets the number of the column where the elements ends. |
int |
getEndLineNumber()
Gets the number of the line where the element ends. |
org.apache.commons.logging.Log |
getLog()
|
int |
getStartColumnNumber()
Gets the number of the column where the element start. |
int |
getStartLineNumber()
Gets the number of the line where the element starts. |
void |
logDiagnosticsInfo(org.apache.commons.logging.Log logger)
Logs diagnotic information about the script coordinate. |
void |
setLog(org.apache.commons.logging.Log logger)
|
SyntaxException |
syntaxException(java.lang.CharSequence message)
Creates a syntax exception based on the given message containing details of the script position. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ScriptCoordinate(int startLineNumber, int startColumnNumber, int endLineNumber, int endColumnNumber)
Method Detail |
---|
public org.apache.commons.logging.Log getLog()
public void setLog(org.apache.commons.logging.Log logger)
public int getEndColumnNumber()
public int getEndLineNumber()
public int getStartColumnNumber()
public int getStartLineNumber()
public SyntaxException syntaxException(java.lang.CharSequence message)
message
- CharSequence
containing the base message, not
null
SyntaxException
with details of the script
position appended to the message, not nullpublic CommandException commandException(java.lang.CharSequence message)
message
- CharSequence
containing the base message, not
null
CommandException
with details of the script
position appended to the message, not nullpublic java.lang.String addStartLineAndColumn(java.lang.CharSequence message)
message
- CharSequence
message, not null
String
containing the original message with
positional phrase appended, not nullpublic void logDiagnosticsInfo(org.apache.commons.logging.Log logger)
logger
- Log
, not nullpublic void debugDiagnostics(org.apache.commons.logging.Log logger)
logger
- Log
, not null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |