Java Doc for Available.java in  » Build » ANT » org » apache » tools » ant » taskdefs » 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 » Build » ANT » org.apache.tools.ant.taskdefs 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.tools.ant.Task
   org.apache.tools.ant.taskdefs.Available

Available
public class Available extends Task implements Condition(Code)
Will set the given property if the requested resource is available at runtime. This task may also be used as a condition by the condition task.
since:
   Ant 1.1

Inner Class :public static class FileDir extends EnumeratedAttribute



Method Summary
public  PathcreateClasspath()
     Classpath to be used when searching for classes and resources.
public  PathcreateFilepath()
     Path to search for file resources.
public  booleaneval()
     Evaluate the availability of a resource.
public  voidexecute()
     Entry point when operating as a task.
public  voidsetClassname(String classname)
     Set a classname of a class which must be available to set the given property.
public  voidsetClasspath(Path classpath)
     Set the classpath to be used when searching for classes and resources.
public  voidsetClasspathRef(Reference r)
     Set the classpath by reference.
public  voidsetFile(File file)
     Set the file which must be present in the file system to set the given property.
public  voidsetFilepath(Path filepath)
     Set the path to use when looking for a file.
public  voidsetIgnoresystemclasses(boolean ignore)
     Set whether the search for classes should ignore the runtime classes and just use the given classpath.
public  voidsetProperty(String property)
     Set the name of the property which will be set if the particular resource is available.
public  voidsetResource(String resource)
     Set the name of a Java resource which is required to set the property.
public  voidsetSearchParents(boolean searchParents)
     Set the searchParents attribute. This controls the behaviour of the the "file" type. If true, the path, parent path and grandparent path are searched for the file.
public  voidsetType(String type)
    
public  voidsetType(FileDir type)
     Set what type of file is required - either directory or file.
public  voidsetValue(String value)
     Set the value to be given to the property if the desired resource is available.



Method Detail
createClasspath
public Path createClasspath()(Code)
Classpath to be used when searching for classes and resources. an empty Path instance to be configured by Ant.



createFilepath
public Path createFilepath()(Code)
Path to search for file resources. a new Path instance which Ant will configure with a file searchpath.



eval
public boolean eval() throws BuildException(Code)
Evaluate the availability of a resource. boolean is the resource is available.
exception:
  BuildException - if the condition is not configured correctly



execute
public void execute() throws BuildException(Code)
Entry point when operating as a task.
exception:
  BuildException - if the task is not configured correctly.



setClassname
public void setClassname(String classname)(Code)
Set a classname of a class which must be available to set the given property.
Parameters:
  classname - the name of the class required.



setClasspath
public void setClasspath(Path classpath)(Code)
Set the classpath to be used when searching for classes and resources.
Parameters:
  classpath - an Ant Path object containing the search path.



setClasspathRef
public void setClasspathRef(Reference r)(Code)
Set the classpath by reference.
Parameters:
  r - a Reference to a Path instance to be used as the classpathvalue.



setFile
public void setFile(File file)(Code)
Set the file which must be present in the file system to set the given property.
Parameters:
  file - the name of the file which is required.



setFilepath
public void setFilepath(Path filepath)(Code)
Set the path to use when looking for a file.
Parameters:
  filepath - a Path instance containing the search path for files.



setIgnoresystemclasses
public void setIgnoresystemclasses(boolean ignore)(Code)
Set whether the search for classes should ignore the runtime classes and just use the given classpath.
Parameters:
  ignore - true if system classes are to be ignored.



setProperty
public void setProperty(String property)(Code)
Set the name of the property which will be set if the particular resource is available.
Parameters:
  property - the name of the property to set.



setResource
public void setResource(String resource)(Code)
Set the name of a Java resource which is required to set the property.
Parameters:
  resource - the name of a resource which is required to be available.



setSearchParents
public void setSearchParents(boolean searchParents)(Code)
Set the searchParents attribute. This controls the behaviour of the the "file" type. If true, the path, parent path and grandparent path are searched for the file. If false, only the path is seached. The default value is false.
Parameters:
  searchParents - the value to set.



setType
public void setType(String type)(Code)

Parameters:
  type - the type of resource



setType
public void setType(FileDir type)(Code)
Set what type of file is required - either directory or file.
Parameters:
  type - an instance of the FileDir enumeratedAttribute indicatingwhether the file required is to be a directory or a plainfile.



setValue
public void setValue(String value)(Code)
Set the value to be given to the property if the desired resource is available.
Parameters:
  value - the value to be given.



Fields inherited from org.apache.tools.ant.Task
protected Target target(Code)(Java Doc)
protected String taskName(Code)(Java Doc)
protected String taskType(Code)(Java Doc)
protected RuntimeConfigurable wrapper(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.Task
final public void bindToOwner(Task owner)(Code)(Java Doc)
public void execute() throws BuildException(Code)(Java Doc)
public Target getOwningTarget()(Code)(Java Doc)
public RuntimeConfigurable getRuntimeConfigurableWrapper()(Code)(Java Doc)
public String getTaskName()(Code)(Java Doc)
public String getTaskType()(Code)(Java Doc)
protected RuntimeConfigurable getWrapper()(Code)(Java Doc)
protected void handleErrorFlush(String output)(Code)(Java Doc)
protected void handleErrorOutput(String output)(Code)(Java Doc)
protected void handleFlush(String output)(Code)(Java Doc)
protected int handleInput(byte[] buffer, int offset, int length) throws IOException(Code)(Java Doc)
protected void handleOutput(String output)(Code)(Java Doc)
public void init() throws BuildException(Code)(Java Doc)
final protected boolean isInvalid()(Code)(Java Doc)
public void log(String msg)(Code)(Java Doc)
public void log(String msg, int msgLevel)(Code)(Java Doc)
public void log(Throwable t, int msgLevel)(Code)(Java Doc)
public void log(String msg, Throwable t, int msgLevel)(Code)(Java Doc)
public void maybeConfigure() throws BuildException(Code)(Java Doc)
final public void perform()(Code)(Java Doc)
public void reconfigure()(Code)(Java Doc)
public void setOwningTarget(Target target)(Code)(Java Doc)
public void setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)(Code)(Java Doc)
public void setTaskName(String name)(Code)(Java Doc)
public void setTaskType(String type)(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.