Class URLResource
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.types.DataType
- 
- org.apache.tools.ant.types.Resource
- 
- org.apache.tools.ant.types.resources.URLResource
 
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- java.lang.Comparable<Resource>,- java.lang.Iterable<Resource>,- ResourceCollection,- URLProvider
 
 public class URLResource extends Resource implements URLProvider Exposes a URL as a Resource.- Since:
- Ant 1.7
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.tools.ant.types.ResourceMAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
 - 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description URLResource()Default constructor.URLResource(java.io.File f)Convenience constructor.URLResource(java.lang.String u)String constructor for Ant attribute introspection.URLResource(java.net.URL u)Convenience constructor.URLResource(URLProvider u)Convenience constructor.
 - 
Method SummaryModifier and Type Method Description protected voidconnect()Ensure that we have a connection.protected voidconnect(int logLevel)Ensure that we have a connection.booleanequals(java.lang.Object another)Test whether an Object equals this URLResource.java.io.InputStreamgetInputStream()Get an InputStream for the Resource.longgetLastModified()Tells the modification time in milliseconds since 01.01.1970 .java.lang.StringgetName()Get the name of this URLResource (its file component minus the leading separator).java.io.OutputStreamgetOutputStream()Get an OutputStream for the Resource.protected URLResourcegetRef()Perform the check for circular references and return the referenced Resource.longgetSize()Get the size of this Resource.java.net.URLgetURL()Get the URL used by this URLResource.inthashCode()Get the hash code for this Resource.booleanisDirectory()Tells if the resource is a directory.booleanisExists()Find out whether the URL exists .voidsetBaseURL(java.net.URL base)Base URL which combined with the relativePath attribute defines the URL.voidsetFile(java.io.File f)Set the URL from a File.voidsetRefid(Reference r)Overrides the super version.voidsetRelativePath(java.lang.String r)Relative path which combined with the baseURL attribute defines the URL.voidsetURL(java.net.URL u)Set the URL for this URLResource.java.lang.StringtoString()Return this URLResource formatted as a String.- 
Methods inherited from class org.apache.tools.ant.types.Resourceas, asOptional, clone, compareTo, getMagicNumber, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString
 - 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectfinalize, getClass, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
 
- 
 
- 
- 
- 
Constructor Detail- 
URLResourcepublic URLResource() Default constructor.
 - 
URLResourcepublic URLResource(java.net.URL u) Convenience constructor.- Parameters:
- u- the URL to expose.
 
 - 
URLResourcepublic URLResource(URLProvider u) Convenience constructor.- Parameters:
- u- holds the URL to expose.
 
 - 
URLResourcepublic URLResource(java.io.File f) Convenience constructor.- Parameters:
- f- the File to set as a URL.
 
 - 
URLResourcepublic URLResource(java.lang.String u) String constructor for Ant attribute introspection.- Parameters:
- u- String representation of this URL.
- See Also:
- IntrospectionHelper
 
 
- 
 - 
Method Detail- 
setURLpublic void setURL(java.net.URL u) Set the URL for this URLResource.- Parameters:
- u- the URL to expose.
 
 - 
setFilepublic void setFile(java.io.File f) Set the URL from a File.- Parameters:
- f- the File to set as a URL.
 
 - 
setBaseURLpublic void setBaseURL(java.net.URL base) Base URL which combined with the relativePath attribute defines the URL.- Parameters:
- base- URL
- Since:
- Ant 1.8.0
 
 - 
setRelativePathpublic void setRelativePath(java.lang.String r) Relative path which combined with the baseURL attribute defines the URL.- Parameters:
- r- String
- Since:
- Ant 1.8.0
 
 - 
getURLpublic java.net.URL getURL() Get the URL used by this URLResource.- Specified by:
- getURLin interface- URLProvider
- Returns:
- a URL object.
 
 - 
setRefidpublic void setRefid(Reference r) Overrides the super version.
 - 
getNamepublic java.lang.String getName() Get the name of this URLResource (its file component minus the leading separator).
 - 
toStringpublic java.lang.String toString() Return this URLResource formatted as a String.
 - 
isExistspublic boolean isExists() Find out whether the URL exists .
 - 
getLastModifiedpublic long getLastModified() Tells the modification time in milliseconds since 01.01.1970 .- Overrides:
- getLastModifiedin class- Resource
- Returns:
- 0 if the resource does not exist to mirror the behavior
 of File.
 
 - 
isDirectorypublic boolean isDirectory() Tells if the resource is a directory.- Overrides:
- isDirectoryin class- Resource
- Returns:
- boolean whether the resource is a directory.
 
 - 
getSizepublic long getSize() Get the size of this Resource.
 - 
equalspublic boolean equals(java.lang.Object another) Test whether an Object equals this URLResource.
 - 
hashCodepublic int hashCode() Get the hash code for this Resource.
 - 
getInputStreampublic java.io.InputStream getInputStream() throws java.io.IOExceptionGet an InputStream for the Resource.- Overrides:
- getInputStreamin class- Resource
- Returns:
- an InputStream containing this Resource's content.
- Throws:
- java.io.IOException- if unable to provide the content of this Resource as a stream.
- java.lang.UnsupportedOperationException- if InputStreams are not supported for this Resource type.
 
 - 
getOutputStreampublic java.io.OutputStream getOutputStream() throws java.io.IOExceptionGet an OutputStream for the Resource.- Overrides:
- getOutputStreamin class- Resource
- Returns:
- an OutputStream to which content can be written.
- Throws:
- java.io.IOException- if unable to provide the content of this Resource as a stream.
- java.lang.UnsupportedOperationException- if OutputStreams are not supported for this Resource type.
- java.io.IOException- if the URL cannot be opened.
 
 - 
connectprotected void connect() throws java.io.IOExceptionEnsure that we have a connection.- Throws:
- java.io.IOException- if the connection cannot be established.
 
 - 
connectprotected void connect(int logLevel) throws java.io.IOExceptionEnsure that we have a connection.- Parameters:
- logLevel- severity to use when logging connection errors. Should be one of the- MSG_constants in- Project.
- Throws:
- java.io.IOException- if the connection cannot be established.
- Since:
- Ant 1.8.2
 
 - 
getRefprotected URLResource getRef() Description copied from class:ResourcePerform the check for circular references and return the referenced Resource.
 
- 
 
-