Java Doc for JTidyTask.java in  » HTML-Parser » JTidy » org » w3c » tidy » ant » 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 » HTML Parser » JTidy » org.w3c.tidy.ant 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.w3c.tidy.ant.JTidyTask

JTidyTask
public class JTidyTask extends Task (Code)
JTidy ant task.

Parameters

Attribute Description Required
srcfile source file Yes, unless a nested <fileset> element is used.
destfile destination file for output With the srcfile attribute, either destfile or destdir can be used. With nested <fileset> elements only destdir is allowed.
destdir destination directory for output
properties Path to a valid tidy properties file No
flatten Ignore the directory structure of the source files, and copy all files into the directory specified by the destdir attribute. No; defaults to false.
failonerror boolean to control whether failure to execute should throw a BuildException or just print an error. If set to true errors in input files which tidy is enable to fix will cause a failure. No; defaults to false.

Nested elements

  • Fileset : if you need to run tidy on more than one file, you can specify nested filesets.
  • Parameter : you can specify any tidy configuration option directly using a nested parameter element.

Setup

Adds the following typedef to setup the JTidy task in your build.xml:

 <taskdef name="tidy" classname="org.w3c.tidy.ant.JTidyTask"/>
 

This will work if JTidy jar is copied to ant lib directory. If you need to reference the jar elsewhere on the filesystem you can add a nested classpath element:

 <taskdef name="tidy" classname="org.w3c.tidy.ant.JTidyTask">
 <classpath>
 <pathelement location="${lib.dir}/jtidy.jar"/>
 </classpath>
 </taskdef>
 

Examples

 <tidy destdir="out" properties="/path/to/tidy.properties">
 <fileset dir="inputdir" />
 <parameter name="drop-font-tags" value="true" />
 </tidy>
 

author:
   Fabrizio Giustina
version:
   $Revision: 1.8 $ ($Author: fgiust $)




Method Summary
public  voidaddConfiguredParameter(Parameter prop)
     Setter method for any property using the ant type Parameter.
public  voidaddFileset(FileSet fileSet)
    
public  voidexecute()
     Run the task.
protected  voidexecuteSet()
     Run tidy on filesets.
protected  voidexecuteSingle()
     A single file has been specified.
public  voidinit()
     Initializes the task.
protected  voidprocessFile(File inputFile, File outputFile)
     Run tidy on a file.
public  voidsetDestdir(File destdir)
    
public  voidsetDestfile(File destfile)
    
public  voidsetFailonerror(boolean failonerror)
    
public  voidsetFlatten(boolean flatten)
    
public  voidsetProperties(File properties)
    
public  voidsetSrcfile(File srcfile)
    
protected  voidvalidateParameters()
     Validates task parameters.



Method Detail
addConfiguredParameter
public void addConfiguredParameter(Parameter prop)(Code)
Setter method for any property using the ant type Parameter.
Parameters:
  prop - Ant type Parameter



addFileset
public void addFileset(FileSet fileSet)(Code)
Adds a fileset to be processed Fileset
Parameters:
  fileSet -



execute
public void execute() throws BuildException(Code)
Run the task.
exception:
  BuildException - The exception raised during task execution.



executeSet
protected void executeSet()(Code)
Run tidy on filesets.



executeSingle
protected void executeSingle()(Code)
A single file has been specified.



init
public void init()(Code)
Initializes the task.



processFile
protected void processFile(File inputFile, File outputFile)(Code)
Run tidy on a file.
Parameters:
  inputFile - input file
Parameters:
  outputFile - output file



setDestdir
public void setDestdir(File destdir)(Code)

Parameters:
  destdir - The destdir to set.



setDestfile
public void setDestfile(File destfile)(Code)

Parameters:
  destfile - The destfile to set.



setFailonerror
public void setFailonerror(boolean failonerror)(Code)

Parameters:
  failonerror - The failonerror to set.



setFlatten
public void setFlatten(boolean flatten)(Code)

Parameters:
  flatten - The flatten to set.



setProperties
public void setProperties(File properties)(Code)

Parameters:
  properties - The properties to set.



setSrcfile
public void setSrcfile(File srcfile)(Code)

Parameters:
  srcfile - The srcfile to set.



validateParameters
protected void validateParameters() throws BuildException(Code)
Validates task parameters.
throws:
  BuildException - if any invalid parameter is found



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