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


org.apache.tools.ant.types.DataType
   org.apache.tools.ant.types.Resource

All known Subclasses:   org.apache.tools.ant.types.resources.CompressedResource,  org.apache.tools.ant.types.resources.StringResource,  org.apache.tools.ant.types.resources.ArchiveResource,  org.apache.tools.ant.types.resources.PropertyResource,  org.apache.tools.ant.types.resources.URLResource,  org.apache.tools.ant.types.resources.JavaResource,  org.apache.tools.ant.types.resources.FileResource,
Resource
public class Resource extends DataType implements Cloneable,Comparable,ResourceCollection(Code)
Describes a "File-like" resource (File, ZipEntry, etc.). This class is meant to be used by classes needing to record path and date/time information about a file, a zip entry or some similar resource (URL, archive in a version control repository, ...).
since:
   Ant 1.5.2
See Also:   org.apache.tools.ant.types.resources.Touchable


Field Summary
final protected static  intMAGIC
    
final public static  longUNKNOWN_DATETIME
    
final public static  longUNKNOWN_SIZE
    

Constructor Summary
public  Resource()
     Default constructor.
public  Resource(String name)
     Only sets the name.

This is a dummy, used for not existing resources.


Parameters:
  name - relative path of the resource.
public  Resource(String name, boolean exists, long lastmodified)
     Sets the name, lastmodified flag, and exists flag.
Parameters:
  name - relative path of the resource.
public  Resource(String name, boolean exists, long lastmodified, boolean directory)
     Sets the name, lastmodified flag, exists flag, and directory flag.
Parameters:
  name - relative path of the resource.
public  Resource(String name, boolean exists, long lastmodified, boolean directory, long size)
     Sets the name, lastmodified flag, exists flag, directory flag, and size.
Parameters:
  name - relative path of the resource.

Method Summary
public  Objectclone()
     Clone this Resource.
public  intcompareTo(Object other)
     Delegates to a comparison of names.
Parameters:
  other - the object to compare to.
public  booleanequals(Object other)
     Implement basic Resource equality.
Parameters:
  other - the object to check against.
public  InputStreamgetInputStream()
     Get an InputStream for the Resource.
public  longgetLastModified()
     Tells the modification time in milliseconds since 01.01.1970 .
protected static  intgetMagicNumber(byte[] seed)
     Create a "magic number" for use in hashCode calculations.
Parameters:
  seed - byte[] to seed with.
public  StringgetName()
     Name attribute will contain the path of a file relative to the root directory of its fileset or the recorded path of a zip entry.
public  OutputStreamgetOutputStream()
     Get an OutputStream for the Resource.
public  longgetSize()
     Get the size of this Resource.
public  inthashCode()
     Get the hash code for this Resource.
public  booleanisDirectory()
     Tells if the resource is a directory.
public  booleanisExists()
     The exists attribute tells whether a file exists.
public  booleanisFilesystemOnly()
     Fulfill the ResourceCollection contract.
public  Iteratoriterator()
     Fulfill the ResourceCollection contract.
public  voidsetDirectory(boolean directory)
     Set the directory attribute.
public  voidsetExists(boolean exists)
     Set the exists attribute.
public  voidsetLastModified(long lastmodified)
     Set the last modification attribute.
public  voidsetName(String name)
     Set the name of this Resource.
Parameters:
  name - relative path of the resource.
public  voidsetRefid(Reference r)
     Overrides the base version.
public  voidsetSize(long size)
     Set the size of this Resource.
public  intsize()
     Fulfill the ResourceCollection contract.
final public  StringtoLongString()
     Get a long String representation of this Resource.
public  StringtoString()
     Get the string representation of this Resource.

Field Detail
MAGIC
final protected static int MAGIC(Code)
Magic number



UNKNOWN_DATETIME
final public static long UNKNOWN_DATETIME(Code)
Constant unknown datetime for getLastModified



UNKNOWN_SIZE
final public static long UNKNOWN_SIZE(Code)
Constant unknown size




Constructor Detail
Resource
public Resource()(Code)
Default constructor.



Resource
public Resource(String name)(Code)
Only sets the name.

This is a dummy, used for not existing resources.


Parameters:
  name - relative path of the resource. Expects"/" to be used as the directory separator.



Resource
public Resource(String name, boolean exists, long lastmodified)(Code)
Sets the name, lastmodified flag, and exists flag.
Parameters:
  name - relative path of the resource. Expects"/" to be used as the directory separator.
Parameters:
  exists - if true, this resource exists.
Parameters:
  lastmodified - the last modification time of this resource.



Resource
public Resource(String name, boolean exists, long lastmodified, boolean directory)(Code)
Sets the name, lastmodified flag, exists flag, and directory flag.
Parameters:
  name - relative path of the resource. Expects"/" to be used as the directory separator.
Parameters:
  exists - if true the resource exists
Parameters:
  lastmodified - the last modification time of the resource
Parameters:
  directory - if true, this resource is a directory



Resource
public Resource(String name, boolean exists, long lastmodified, boolean directory, long size)(Code)
Sets the name, lastmodified flag, exists flag, directory flag, and size.
Parameters:
  name - relative path of the resource. Expects"/" to be used as the directory separator.
Parameters:
  exists - if true the resource exists
Parameters:
  lastmodified - the last modification time of the resource
Parameters:
  directory - if true, this resource is a directory
Parameters:
  size - the size of this resource.




Method Detail
clone
public Object clone()(Code)
Clone this Resource. copy of this.



compareTo
public int compareTo(Object other)(Code)
Delegates to a comparison of names.
Parameters:
  other - the object to compare to. a negative integer, zero, or a positive integer as this Resourceis less than, equal to, or greater than the specified Resource.
since:
   Ant 1.6



equals
public boolean equals(Object other)(Code)
Implement basic Resource equality.
Parameters:
  other - the object to check against. true if the specified Object is equal to this Resource.
since:
   Ant 1.7



getInputStream
public InputStream getInputStream() throws IOException(Code)
Get an InputStream for the Resource. an InputStream containing this Resource's content.
throws:
  IOException - if unable to provide the content of thisResource as a stream.
throws:
  UnsupportedOperationException - if InputStreams are notsupported for this Resource type.
since:
   Ant 1.7



getLastModified
public long getLastModified()(Code)
Tells the modification time in milliseconds since 01.01.1970 . 0 if the resource does not exist to mirror the behaviorof java.io.File File.



getMagicNumber
protected static int getMagicNumber(byte[] seed)(Code)
Create a "magic number" for use in hashCode calculations.
Parameters:
  seed - byte[] to seed with. a magic number as int.



getName
public String getName()(Code)
Name attribute will contain the path of a file relative to the root directory of its fileset or the recorded path of a zip entry.

example for a file with fullpath /var/opt/adm/resource.txt in a file set with root dir /var/opt it will be adm/resource.txt.

"/" will be used as the directory separator.

the name of this resource.



getOutputStream
public OutputStream getOutputStream() throws IOException(Code)
Get an OutputStream for the Resource. an OutputStream to which content can be written.
throws:
  IOException - if unable to provide the content of thisResource as a stream.
throws:
  UnsupportedOperationException - if OutputStreams are notsupported for this Resource type.
since:
   Ant 1.7



getSize
public long getSize()(Code)
Get the size of this Resource. the size, as a long, 0 if the Resource does not exist (forcompatibility with java.io.File), or UNKNOWN_SIZE if not known.
since:
   Ant 1.6.3



hashCode
public int hashCode()(Code)
Get the hash code for this Resource. hash code as int.
since:
   Ant 1.7



isDirectory
public boolean isDirectory()(Code)
Tells if the resource is a directory. boolean flag indicating if the resource is a directory.



isExists
public boolean isExists()(Code)
The exists attribute tells whether a file exists. true if this resource exists.



isFilesystemOnly
public boolean isFilesystemOnly()(Code)
Fulfill the ResourceCollection contract. whether this Resource is a FileResource.
since:
   Ant 1.7



iterator
public Iterator iterator()(Code)
Fulfill the ResourceCollection contract. an Iterator of Resources.
since:
   Ant 1.7



setDirectory
public void setDirectory(boolean directory)(Code)
Set the directory attribute.
Parameters:
  directory - if true, this resource is a directory.



setExists
public void setExists(boolean exists)(Code)
Set the exists attribute.
Parameters:
  exists - if true, this resource exists.



setLastModified
public void setLastModified(long lastmodified)(Code)
Set the last modification attribute.
Parameters:
  lastmodified - the modification time in milliseconds since 01.01.1970.



setName
public void setName(String name)(Code)
Set the name of this Resource.
Parameters:
  name - relative path of the resource. Expects"/" to be used as the directory separator.



setRefid
public void setRefid(Reference r)(Code)
Overrides the base version.
Parameters:
  r - the Reference to set.



setSize
public void setSize(long size)(Code)
Set the size of this Resource.
Parameters:
  size - the size, as a long.
since:
   Ant 1.6.3



size
public int size()(Code)
Fulfill the ResourceCollection contract. the size of this ResourceCollection.
since:
   Ant 1.7



toLongString
final public String toLongString()(Code)
Get a long String representation of this Resource. This typically should be the value of toString() prefixed by a type description. this Resource formatted as a long String.
since:
   Ant 1.7



toString
public String toString()(Code)
Get the string representation of this Resource. this Resource formatted as a String.
since:
   Ant 1.7



Fields inherited from org.apache.tools.ant.types.DataType
protected boolean checked(Code)(Java Doc)
protected Reference ref(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.types.DataType
protected void checkAttributesAllowed()(Code)(Java Doc)
protected void checkChildrenAllowed()(Code)(Java Doc)
protected BuildException circularReference()(Code)(Java Doc)
public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
protected void dieOnCircularReference()(Code)(Java Doc)
protected void dieOnCircularReference(Project p)(Code)(Java Doc)
protected void dieOnCircularReference(Stack stack, Project project) throws BuildException(Code)(Java Doc)
protected Object getCheckedRef()(Code)(Java Doc)
protected Object getCheckedRef(Project p)(Code)(Java Doc)
protected Object getCheckedRef(Class requiredClass, String dataTypeName)(Code)(Java Doc)
protected Object getCheckedRef(Class requiredClass, String dataTypeName, Project project)(Code)(Java Doc)
protected String getDataTypeName()(Code)(Java Doc)
public Reference getRefid()(Code)(Java Doc)
public static void invokeCircularReferenceCheck(DataType dt, Stack stk, Project p)(Code)(Java Doc)
protected boolean isChecked()(Code)(Java Doc)
public boolean isReference()(Code)(Java Doc)
protected BuildException noChildrenAllowed()(Code)(Java Doc)
protected void setChecked(boolean checked)(Code)(Java Doc)
public void setRefid(Reference ref)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
protected BuildException tooManyAttributes()(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.