| Modifier and Type | Method and Description |
|---|---|
void |
consumeException(Throwable t)
Marks an exception as having been processed by a logger.
|
OutputListener |
createStandardHyperlink(URL file,
String message,
int line1,
int column1,
int line2,
int column2)
Convenience method to create a standard hyperlink implementation.
|
void |
deliverMessageLogged(AntEvent originalEvent,
String message,
int level)
Deliver a message logged event to all matching loggers.
|
Object |
getCustomData(AntLogger logger)
Get optional data stored by the logger in this session.
|
String |
getDisplayName()
Get a display name used for the session as a whole.
|
InputOutput |
getIO()
Obtains the I/O handle for advanced operations such as
IOColors. |
File |
getOriginatingScript()
Get the Ant script originally invoked.
|
String[] |
getOriginatingTargets()
Get the Ant targets originally run.
|
Map<String,String> |
getProperties()
Gets a set of user properties defined for this session.
|
int |
getVerbosity()
Get the (user-requested) verbosity level for this session.
|
boolean |
isConcealed(String propertyName)
Checks if the property is concealed.
|
boolean |
isExceptionConsumed(Throwable t)
Tests whether a given exception has already been consumed by some logger.
|
void |
println(String message,
boolean err,
OutputListener listener)
Print a line of text to the Ant output.
|
void |
putCustomData(AntLogger logger,
Object data)
Store custom data associated with this session.
|
String |
toString() |
public File getOriginatingScript()
public String[] getOriginatingTargets()
AntLogger.buildInitializationFailed(org.apache.tools.ant.module.spi.AntEvent))public Object getCustomData(AntLogger logger)
logger - the logger which wishes to retrieve datapublic void putCustomData(AntLogger logger, Object data)
logger - the logger which wishes to store datadata - some custom data to retainpublic void println(String message, boolean err, OutputListener listener)
message - a message to print (newline will be appended automatically)err - true to send to the error stream, false for regular outputlistener - an output listener suitable for hyperlinks, or null for a plain printAntSession.createStandardHyperlink(java.net.URL, java.lang.String, int, int, int, int)public void deliverMessageLogged(AntEvent originalEvent, String message, int level)
Loggers will receive AntLogger.messageLogged(org.apache.tools.ant.module.spi.AntEvent) with an event
similar to the original event except for the message and log level;
also the exception will always be null and the event will initially
be unconsumed.
This call blocks until all loggers have processed the nested event. Note that this logger may also receive the event so it must be reentrant.
Loggers are discouraged from using this facility merely to create hyperlinks
for which the target is known. Use AntSession.println(java.lang.String, boolean, org.openide.windows.OutputListener) instead. This method
is primarily intended for use from the standard logger to deliver stack
trace lines to other loggers which may be able to hyperlink them.
originalEvent - the original event received by the calling loggermessage - a message to log (see AntEvent.getMessage())level - the level to log it at (see AntEvent.getLogLevel())public void consumeException(Throwable t) throws IllegalStateException
A single build-halting exception can traverse any number of Ant events as it progresses outwards, typically from the failing task to the failing target (possibly several times due to subprojects) and finally to the build failure.
Consuming the exception permits a logger to indicate to other loggers that it
has already handled the problem in an appropriate manner. Since the standard
logger may print an exception (possibly with stack trace) that is part of
a AntLogger.buildFinished(org.apache.tools.ant.module.spi.AntEvent) event, loggers which deal with the exception
in some other way should consume it before returning from the callback.
t - an exception to mark as consumedIllegalStateException - if it was already consumedpublic boolean isExceptionConsumed(Throwable t)
Note that if an exception is consumed, any exception with that exception
as its Throwable.getCause() (possibly recursively) is also considered
consumed. This is useful because Ant's ProjectHelper.addLocationToBuildException
will annotate BuildExceptions with location information by constructing
wrapper exceptions.
t - an exceptionAntSession.consumeException(java.lang.Throwable)public int getVerbosity()
AntEvent.LOG_INFOpublic Map<String,String> getProperties()
public boolean isConcealed(String propertyName)
propertyName - the property name to checkpublic String getDisplayName()
public OutputListener createStandardHyperlink(URL file, String message, int line1, int column1, int line2, int column2)
file - a file to link to (may or may not exist, but hyperlink will not work if it does not)message - a message to use e.g. for the status bar when clicking on the hyperlink,
or for annotation tool tipsline1 - the starting line number, or -1 if there is no associated line numbercolumn1 - the starting column number, or -1 if there is no associated column number
(must be -1 if line1 is -1)line2 - the ending line number, or -1 for a single-line link
(must be -1 if line1 is -1)column2 - the ending column number, or -1 if not applicable
(must be -1 if either line2 or column1 is -1)AntSession.println(java.lang.String, boolean, org.openide.windows.OutputListener)public InputOutput getIO()
IOColors.