Java Doc for AntEvent.java in  » IDE-Netbeans » library » org » apache » tools » ant » module » spi » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » IDE Netbeans » library » org.apache.tools.ant.module.spi 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.tools.ant.module.spi.AntEvent

AntEvent
final public class AntEvent (Code)
One event delivered to an AntLogger .

Note that one event is shared across all listeners.

The information available from the event represents a best effort to gather information from the Ant run. Some versions of Ant may not support all of these capabilities, in which case the event method will simply return null or whatever the documented fallback value is. For example, Ant 1.5 does not permit details of task structure to be introspected, but 1.6 does.


author:
   Jesse Glick
since:
   org.apache.tools.ant.module/3 3.12


Field Summary
final public static  intLOG_DEBUG
     Debugging log level.
final public static  intLOG_ERR
     Error log level.
final public static  intLOG_INFO
     Information log level.
final public static  intLOG_VERBOSE
     Verbose log level.
final public static  intLOG_WARN
     Warning log level.


Method Summary
public  voidconsume()
     Mark an event as consumed to advise other loggers not to handle it.
public  Stringevaluate(String text)
     Evaluate a string with possible substitutions according to defined properties.
public  ThrowablegetException()
     Get a terminating exception.
public  intgetLine()
     Get the line number in AntEvent.getScriptLocation corresponding to this event.
public  intgetLogLevel()
     Get the log level of the message. Applies only to AntLogger.messageLogged . Note that lower numbers are higher priority. the log level (e.g.
public  StringgetMessage()
     Get the name of the message being logged.
public  StringgetProperty(String name)
     Get a property set on the current Ant project.
public  Set<String>getPropertyNames()
     Get a set of property names defined on the current Ant project.
public  FilegetScriptLocation()
     Get the location of the Ant script producing this event.
public  AntSessiongetSession()
     Get the associated session.
public  StringgetTargetName()
     Get the name of the target in AntEvent.getScriptLocation producing this event.
public  StringgetTaskName()
     Get the name of the task producing this event. XXX semantics w.r.t.
public  TaskStructuregetTaskStructure()
     Get the configured XML structure of the task producing this event.
public  booleanisConsumed()
     Test whether this event has already been consumed by some other logger.
public  StringtoString()
    

Field Detail
LOG_DEBUG
final public static int LOG_DEBUG(Code)
Debugging log level.



LOG_ERR
final public static int LOG_ERR(Code)
Error log level.



LOG_INFO
final public static int LOG_INFO(Code)
Information log level.



LOG_VERBOSE
final public static int LOG_VERBOSE(Code)
Verbose log level.



LOG_WARN
final public static int LOG_WARN(Code)
Warning log level.





Method Detail
consume
public void consume() throws IllegalStateException(Code)
Mark an event as consumed to advise other loggers not to handle it.
throws:
  IllegalStateException - if it was already consumed



evaluate
public String evaluate(String text)(Code)
Evaluate a string with possible substitutions according to defined properties.
Parameters:
  text - the text to evaluate its value (may be the same as the incoming text), never null
See Also:   TaskStructure.getAttribute
See Also:   TaskStructure.getText



getException
public Throwable getException()(Code)
Get a terminating exception. Applies only to AntLogger.buildFinished and AntLogger.buildInitializationFailed . an exception ending the build, or null for normal completion or if inapplicable



getLine
public int getLine()(Code)
Get the line number in AntEvent.getScriptLocation corresponding to this event. Line numbers start at one. the line number, or -1 if unknown



getLogLevel
public int getLogLevel()(Code)
Get the log level of the message. Applies only to AntLogger.messageLogged . Note that lower numbers are higher priority. the log level (e.g. LOG_INFO), or -1 if inapplicable



getMessage
public String getMessage()(Code)
Get the name of the message being logged. Applies only to AntLogger.messageLogged . the message, or null if inapplicable



getProperty
public String getProperty(String name)(Code)
Get a property set on the current Ant project.
Parameters:
  name - the property name its value, or null



getPropertyNames
public Set<String> getPropertyNames()(Code)
Get a set of property names defined on the current Ant project. a set of property names; may be empty but not null



getScriptLocation
public File getScriptLocation()(Code)
Get the location of the Ant script producing this event. the script location, or null if unknown



getSession
public AntSession getSession()(Code)
Get the associated session. the session object



getTargetName
public String getTargetName()(Code)
Get the name of the target in AntEvent.getScriptLocation producing this event. Some events occur outside targets and so there will be no target name. the target name (never empty), or null if unknown or inapplicable



getTaskName
public String getTaskName()(Code)
Get the name of the task producing this event. XXX semantics w.r.t. namespaces, taskdefs, etc.? Some events occur outside of tasks and so there will be no name. the task name (never empty), or null if unknown or inapplicable



getTaskStructure
public TaskStructure getTaskStructure()(Code)
Get the configured XML structure of the task producing this event. Some events occur outside of tasks and so there will be no information. the task structure, or null if unknown or inapplicable



isConsumed
public boolean isConsumed()(Code)
Test whether this event has already been consumed by some other logger. true if it has already been consumed



toString
public String toString()(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.