From 8751ca0a45b9343f37161c9f762fb4c485944a5f Mon Sep 17 00:00:00 2001 From: beckerdo Date: Sun, 1 Feb 2009 20:45:55 +0000 Subject: TUSCANY-2485 Add JavaDocs for Tuscany 1.4 git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@739833 13f79535-47bb-0310-9956-ffa450edef68 --- .../service/util/FileHelper.RegExpFilter.html | 306 ++++++++ .../sca/contribution/service/util/FileHelper.html | 835 +++++++++++++++++++++ .../service/util/IOHelper.SafeURLInputStream.html | 494 ++++++++++++ .../sca/contribution/service/util/IOHelper.html | 353 +++++++++ .../contribution/service/util/package-frame.html | 38 + .../contribution/service/util/package-summary.html | 167 +++++ .../contribution/service/util/package-tree.html | 155 ++++ 7 files changed, 2348 insertions(+) create mode 100644 site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.RegExpFilter.html create mode 100644 site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.html create mode 100644 site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.SafeURLInputStream.html create mode 100644 site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.html create mode 100644 site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-frame.html create mode 100644 site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-summary.html create mode 100644 site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-tree.html (limited to 'site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util') diff --git a/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.RegExpFilter.html b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.RegExpFilter.html new file mode 100644 index 0000000000..faf50e6599 --- /dev/null +++ b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.RegExpFilter.html @@ -0,0 +1,306 @@ + + + + + + +FileHelper.RegExpFilter + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.tuscany.sca.contribution.service.util +
+Class FileHelper.RegExpFilter

+
+java.lang.Object
+  extended by org.apache.tuscany.sca.contribution.service.util.FileHelper.RegExpFilter
+
+
+
All Implemented Interfaces:
java.io.FileFilter
+
+
+
Enclosing class:
FileHelper
+
+
+
+
public static class FileHelper.RegExpFilter
extends java.lang.Object
implements java.io.FileFilter
+ + +

+A regular-expression based resource filter +

+ +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
FileHelper.RegExpFilter(java.util.regex.Pattern pattern) + +
+           
FileHelper.RegExpFilter(java.lang.String patternStr, + boolean ignoreCase) + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ booleanaccept(java.io.File file) + +
+           
+static FileHelper.RegExpFiltergetWildcardFilter(java.lang.String str, + boolean ignoreCase) + +
+          Convert wildcard into a regex pattern
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+FileHelper.RegExpFilter

+
+public FileHelper.RegExpFilter(java.util.regex.Pattern pattern)
+
+
+
+ +

+FileHelper.RegExpFilter

+
+public FileHelper.RegExpFilter(java.lang.String patternStr,
+                               boolean ignoreCase)
+
+
+ + + + + + + + +
+Method Detail
+ +

+accept

+
+public boolean accept(java.io.File file)
+
+
+
Specified by:
accept in interface java.io.FileFilter
+
+
+
+
+
+
+ +

+getWildcardFilter

+
+public static FileHelper.RegExpFilter getWildcardFilter(java.lang.String str,
+                                                        boolean ignoreCase)
+
+
Convert wildcard into a regex pattern +

+

+
+
+
+
Parameters:
str - +
Returns:
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.html b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.html new file mode 100644 index 0000000000..da98549b4e --- /dev/null +++ b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/FileHelper.html @@ -0,0 +1,835 @@ + + + + + + +FileHelper + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.tuscany.sca.contribution.service.util +
+Class FileHelper

+
+java.lang.Object
+  extended by org.apache.tuscany.sca.contribution.service.util.FileHelper
+
+
+
+
public class FileHelper
extends java.lang.Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classFileHelper.RegExpFilter + +
+          A regular-expression based resource filter
+  + + + + + + + + + + +
+Constructor Summary
FileHelper() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidcleanDirectory(java.io.File directory) + +
+          Clean a directory without deleting it.
+static voidcopyDirectory(java.io.File srcDir, + java.io.File destDir) + +
+          Copies a whole directory to a new location preserving the file dates.
+static voidcopyDirectory(java.io.File srcDir, + java.io.File destDir, + boolean preserveFileDate) + +
+          Copies a whole directory to a new location.
+static voidcopyDirectoryToDirectory(java.io.File srcDir, + java.io.File destDir) + +
+          Copies a directory to within another directory preserving the file dates.
+static voidcopyFile(java.io.File srcFile, + java.io.File destFile) + +
+          Copies a file to a new location preserving the file date.
+static voidcopyFile(java.io.File srcFile, + java.io.File destFile, + boolean preserveFileDate) + +
+          Copies a file to a new location.
+static voidcopyFileToDirectory(java.io.File srcFile, + java.io.File destDir) + +
+          Copies a file to a directory preserving the file date.
+static voidcopyFileToDirectory(java.io.File srcFile, + java.io.File destDir, + boolean preserveFileDate) + +
+          Copies a file to a directory optionally preserving the file date.
+static voiddeleteDirectory(java.io.File directory) + +
+          Recursively delete a directory.
+static voidforceDelete(java.io.File file) + +
+          Delete a file.
+static voidforceDeleteOnExit(java.io.File file) + +
+          Schedule a file to be deleted when JVM exits.
+static voidforceMkdir(java.io.File directory) + +
+          Make a directory, including any necessary but nonexistent parent + directories.
+static java.lang.StringgetExtension(java.lang.String filename) + +
+          Gets the extension of a filename.
+static java.io.FileFiltergetFileFilter(java.lang.String regExp, + boolean ignoreCase) + +
+           
+static java.lang.StringgetName(java.lang.String fileName) + +
+          Gets the name minus the path from a full filename.
+static intindexOfExtension(java.lang.String filename) + +
+          Returns the index of the last extension separator character, which is a + dot.
+static intindexOfLastSeparator(java.lang.String filename) + +
+          Returns the index of the last directory separator character.
+static java.io.FiletoFile(java.net.URL url) + +
+          Convert from a URL to a File.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+FileHelper

+
+public FileHelper()
+
+
+ + + + + + + + +
+Method Detail
+ +

+indexOfLastSeparator

+
+public static int indexOfLastSeparator(java.lang.String filename)
+
+
Returns the index of the last directory separator character. +

+ This method will handle a file in either Unix or Windows format. The + position of the last forward or backslash is returned. +

+ The output will be the same irrespective of the machine that the code is + running on. +

+

+
Parameters:
filename - the filename to find the last path separator in, null + returns -1 +
Returns:
the index of the last separator character, or -1 if there is no + such character
+
+
+
+ +

+indexOfExtension

+
+public static int indexOfExtension(java.lang.String filename)
+
+
Returns the index of the last extension separator character, which is a + dot. +

+ This method also checks that there is no directory separator after the + last dot. To do this it uses indexOfLastSeparator(String) which + will handle a file in either Unix or Windows format. +

+ The output will be the same irrespective of the machine that the code is + running on. +

+

+
Parameters:
filename - the filename to find the last path separator in, null + returns -1 +
Returns:
the index of the last separator character, or -1 if there is no + such character
+
+
+
+ +

+getName

+
+public static java.lang.String getName(java.lang.String fileName)
+
+
Gets the name minus the path from a full filename. +

+ This method will handle a file in either Unix or Windows format. The text + after the last forward or backslash is returned. + +

+ a/b/c.txt --> c.txt
+ a.txt     --> a.txt
+ a/b/c     --> c
+ a/b/c/    --> ""
+ 
+ +

+ The output will be the same irrespective of the machine that the code is + running on. +

+

+
Parameters:
fileName - the filename to query, null returns null +
Returns:
the name of the file without the path, or an empty string if none + exists
+
+
+
+ +

+getExtension

+
+public static java.lang.String getExtension(java.lang.String filename)
+
+
Gets the extension of a filename. +

+ This method returns the textual part of the filename after the last dot. + There must be no directory separator after the dot. + +

+ foo.txt      --> "txt"
+ a/b/c.jpg    --> "jpg"
+ a/b.txt/c    --> ""
+ a/b/c        --> ""
+ 
+ +

+ The output will be the same irrespective of the machine that the code is + running on. +

+

+
Parameters:
filename - the filename to retrieve the extension of. +
Returns:
the extension of the file or an empty string if none exists.
+
+
+
+ +

+forceMkdir

+
+public static void forceMkdir(java.io.File directory)
+                       throws java.io.IOException
+
+
Make a directory, including any necessary but nonexistent parent + directories. If there already exists a file with specified name or the + directory cannot be created then an exception is thrown. +

+

+
Parameters:
directory - directory to create, not null +
Throws: +
java.lang.NullPointerException - if the directory is null +
java.io.IOException - if the directory cannot be created
+
+
+
+ +

+forceDelete

+
+public static void forceDelete(java.io.File file)
+                        throws java.io.IOException
+
+
Delete a file. If file is a directory, delete it and all sub-directories. +

+ The difference between File.delete() and this method are: +

    +
  • A directory to be deleted does not have to be empty.
  • +
  • You get exceptions when a file or directory cannot be deleted. + (java.io.File methods returns a boolean)
  • +
+

+

+
Parameters:
file - file or directory to delete, not null +
Throws: +
java.lang.NullPointerException - if the directory is null +
java.io.IOException - in case deletion is unsuccessful
+
+
+
+ +

+toFile

+
+public static java.io.File toFile(java.net.URL url)
+
+
Convert from a URL to a File. +

+ From version 1.1 this method will decode the URL. Syntax such as + file:///my%20docs/file.txt will be correctly decoded to + /my docs/file.txt. +

+

+
Parameters:
url - the file URL to convert, null returns null +
Returns:
the equivalent File object, or null + if the URL's protocol is not file +
Throws: +
java.lang.IllegalArgumentException - if the file is incorrectly encoded
+
+
+
+ +

+getFileFilter

+
+public static java.io.FileFilter getFileFilter(java.lang.String regExp,
+                                               boolean ignoreCase)
+
+
+
+
+
+
+ +

+cleanDirectory

+
+public static void cleanDirectory(java.io.File directory)
+                           throws java.io.IOException
+
+
Clean a directory without deleting it. +

+

+
Parameters:
directory - directory to clean +
Throws: +
java.io.IOException - in case cleaning is unsuccessful
+
+
+
+ +

+copyDirectory

+
+public static void copyDirectory(java.io.File srcDir,
+                                 java.io.File destDir)
+                          throws java.io.IOException
+
+
Copies a whole directory to a new location preserving the file dates. +

+ This method copies the specified directory and all its child directories + and files to the specified destination. The destination is the new + location and name of the directory. +

+ The destination directory is created if it does not exist. If the + destination directory did exist, then this method merges the source with + the destination, with the source taking precedence. +

+

+
Parameters:
srcDir - an existing directory to copy, must not be + null
destDir - the new directory, must not be null +
Throws: +
java.lang.NullPointerException - if source or destination is + null +
java.io.IOException - if source or destination is invalid +
java.io.IOException - if an IO error occurs during copying
Since:
+
Commons IO 1.1
+
+
+
+
+ +

+copyDirectory

+
+public static void copyDirectory(java.io.File srcDir,
+                                 java.io.File destDir,
+                                 boolean preserveFileDate)
+                          throws java.io.IOException
+
+
Copies a whole directory to a new location. +

+ This method copies the contents of the specified source directory to + within the specified destination directory. +

+ The destination directory is created if it does not exist. If the + destination directory did exist, then this method merges the source with + the destination, with the source taking precedence. +

+

+
Parameters:
srcDir - an existing directory to copy, must not be + null
destDir - the new directory, must not be null
preserveFileDate - true if the file date of the copy should be the + same as the original +
Throws: +
java.lang.NullPointerException - if source or destination is + null +
java.io.IOException - if source or destination is invalid +
java.io.IOException - if an IO error occurs during copying
Since:
+
Commons IO 1.1
+
+
+
+
+ +

+copyDirectoryToDirectory

+
+public static void copyDirectoryToDirectory(java.io.File srcDir,
+                                            java.io.File destDir)
+                                     throws java.io.IOException
+
+
Copies a directory to within another directory preserving the file dates. +

+ This method copies the source directory and all its contents to a + directory of the same name in the specified destination directory. +

+ The destination directory is created if it does not exist. If the + destination directory did exist, then this method merges the source with + the destination, with the source taking precedence. +

+

+
Parameters:
srcDir - an existing directory to copy, must not be + null
destDir - the directory to place the copy in, must not be + null +
Throws: +
java.lang.NullPointerException - if source or destination is + null +
java.io.IOException - if source or destination is invalid +
java.io.IOException - if an IO error occurs during copying
Since:
+
Commons IO 1.2
+
+
+
+
+ +

+copyFile

+
+public static void copyFile(java.io.File srcFile,
+                            java.io.File destFile)
+                     throws java.io.IOException
+
+
Copies a file to a new location preserving the file date. +

+ This method copies the contents of the specified source file to the + specified destination file. The directory holding the destination file is + created if it does not exist. If the destination file exists, then this + method will overwrite it. +

+

+
Parameters:
srcFile - an existing file to copy, must not be null
destFile - the new file, must not be null +
Throws: +
java.lang.NullPointerException - if source or destination is + null +
java.io.IOException - if source or destination is invalid +
java.io.IOException - if an IO error occurs during copying
See Also:
copyFileToDirectory(File, File)
+
+
+
+ +

+copyFile

+
+public static void copyFile(java.io.File srcFile,
+                            java.io.File destFile,
+                            boolean preserveFileDate)
+                     throws java.io.IOException
+
+
Copies a file to a new location. +

+ This method copies the contents of the specified source file to the + specified destination file. The directory holding the destination file is + created if it does not exist. If the destination file exists, then this + method will overwrite it. +

+

+
Parameters:
srcFile - an existing file to copy, must not be null
destFile - the new file, must not be null
preserveFileDate - true if the file date of the copy should be the + same as the original +
Throws: +
java.lang.NullPointerException - if source or destination is + null +
java.io.IOException - if source or destination is invalid +
java.io.IOException - if an IO error occurs during copying
See Also:
copyFileToDirectory(File, File, boolean)
+
+
+
+ +

+copyFileToDirectory

+
+public static void copyFileToDirectory(java.io.File srcFile,
+                                       java.io.File destDir)
+                                throws java.io.IOException
+
+
Copies a file to a directory preserving the file date. +

+ This method copies the contents of the specified source file to a file of + the same name in the specified destination directory. The destination + directory is created if it does not exist. If the destination file + exists, then this method will overwrite it. +

+

+
Parameters:
srcFile - an existing file to copy, must not be null
destDir - the directory to place the copy in, must not be + null +
Throws: +
java.lang.NullPointerException - if source or destination is null +
java.io.IOException - if source or destination is invalid +
java.io.IOException - if an IO error occurs during copying
See Also:
copyFile(File, File, boolean)
+
+
+
+ +

+copyFileToDirectory

+
+public static void copyFileToDirectory(java.io.File srcFile,
+                                       java.io.File destDir,
+                                       boolean preserveFileDate)
+                                throws java.io.IOException
+
+
Copies a file to a directory optionally preserving the file date. +

+ This method copies the contents of the specified source file to a file of + the same name in the specified destination directory. The destination + directory is created if it does not exist. If the destination file + exists, then this method will overwrite it. +

+

+
Parameters:
srcFile - an existing file to copy, must not be null
destDir - the directory to place the copy in, must not be + null
preserveFileDate - true if the file date of the copy should be the + same as the original +
Throws: +
java.lang.NullPointerException - if source or destination is + null +
java.io.IOException - if source or destination is invalid +
java.io.IOException - if an IO error occurs during copying
Since:
+
Commons IO 1.3
+
See Also:
copyFile(File, File, boolean)
+
+
+
+ +

+deleteDirectory

+
+public static void deleteDirectory(java.io.File directory)
+                            throws java.io.IOException
+
+
Recursively delete a directory. +

+

+
Parameters:
directory - directory to delete +
Throws: +
java.io.IOException - in case deletion is unsuccessful
+
+
+
+ +

+forceDeleteOnExit

+
+public static void forceDeleteOnExit(java.io.File file)
+                              throws java.io.IOException
+
+
Schedule a file to be deleted when JVM exits. If file is directory delete + it and all sub-directories. +

+

+
Parameters:
file - file or directory to delete, must not be null +
Throws: +
java.lang.NullPointerException - if the file is null +
java.io.IOException - in case deletion is unsuccessful
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.SafeURLInputStream.html b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.SafeURLInputStream.html new file mode 100644 index 0000000000..97cc5b8087 --- /dev/null +++ b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.SafeURLInputStream.html @@ -0,0 +1,494 @@ + + + + + + +IOHelper.SafeURLInputStream + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.tuscany.sca.contribution.service.util +
+Class IOHelper.SafeURLInputStream

+
+java.lang.Object
+  extended by java.io.InputStream
+      extended by org.apache.tuscany.sca.contribution.service.util.IOHelper.SafeURLInputStream
+
+
+
All Implemented Interfaces:
java.io.Closeable
+
+
+
Enclosing class:
IOHelper
+
+
+
+
public static class IOHelper.SafeURLInputStream
extends java.io.InputStream
+ + +

+This class is a workaround for URL stream issue as illustrated below. + InputStream is=url.getInputStream(); is.close(); // This line doesn't close + the JAR file if the URL is a jar entry like "jar:file:/a.jar!/my.composite" We + also need to turn off the JarFile cache. +

+ +

+

+
See Also:
http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4950148
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
IOHelper.SafeURLInputStream(java.net.JarURLConnection connection) + +
+           
IOHelper.SafeURLInputStream(java.net.URL url) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intavailable() + +
+           
+ voidclose() + +
+           
+ voidmark(int readlimit) + +
+           
+ booleanmarkSupported() + +
+           
+ intread() + +
+           
+ intread(byte[] b) + +
+           
+ intread(byte[] b, + int off, + int len) + +
+           
+ voidreset() + +
+           
+ longskip(long n) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IOHelper.SafeURLInputStream

+
+public IOHelper.SafeURLInputStream(java.net.URL url)
+                            throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+
+ +

+IOHelper.SafeURLInputStream

+
+public IOHelper.SafeURLInputStream(java.net.JarURLConnection connection)
+                            throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+ + + + + + + + +
+Method Detail
+ +

+available

+
+public int available()
+              throws java.io.IOException
+
+
+
Overrides:
available in class java.io.InputStream
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+close

+
+public void close()
+           throws java.io.IOException
+
+
+
Specified by:
close in interface java.io.Closeable
Overrides:
close in class java.io.InputStream
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+mark

+
+public void mark(int readlimit)
+
+
+
Overrides:
mark in class java.io.InputStream
+
+
+
+
+
+
+ +

+markSupported

+
+public boolean markSupported()
+
+
+
Overrides:
markSupported in class java.io.InputStream
+
+
+
+
+
+
+ +

+read

+
+public int read()
+         throws java.io.IOException
+
+
+
Specified by:
read in class java.io.InputStream
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+read

+
+public int read(byte[] b,
+                int off,
+                int len)
+         throws java.io.IOException
+
+
+
Overrides:
read in class java.io.InputStream
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+read

+
+public int read(byte[] b)
+         throws java.io.IOException
+
+
+
Overrides:
read in class java.io.InputStream
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+reset

+
+public void reset()
+           throws java.io.IOException
+
+
+
Overrides:
reset in class java.io.InputStream
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+skip

+
+public long skip(long n)
+          throws java.io.IOException
+
+
+
Overrides:
skip in class java.io.InputStream
+
+
+ +
Throws: +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.html b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.html new file mode 100644 index 0000000000..02f12dc71f --- /dev/null +++ b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/IOHelper.html @@ -0,0 +1,353 @@ + + + + + + +IOHelper + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +org.apache.tuscany.sca.contribution.service.util +
+Class IOHelper

+
+java.lang.Object
+  extended by org.apache.tuscany.sca.contribution.service.util.IOHelper
+
+
+
+
public class IOHelper
extends java.lang.Object
+ + +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classIOHelper.SafeURLInputStream + +
+          This class is a workaround for URL stream issue as illustrated below.
+  + + + + + + + + + + +
+Constructor Summary
IOHelper() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static voidcloseQuietly(java.io.InputStream input) + +
+          Unconditionally close an InputStream.
+static voidcloseQuietly(java.io.OutputStream output) + +
+          Unconditionally close an OutputStream.
+static intcopy(java.io.InputStream input, + java.io.OutputStream output) + +
+          Copy bytes from an InputStream to an + OutputStream.
+static java.io.InputStreamgetInputStream(java.net.URL url) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+IOHelper

+
+public IOHelper()
+
+
+ + + + + + + + +
+Method Detail
+ +

+closeQuietly

+
+public static void closeQuietly(java.io.InputStream input)
+
+
Unconditionally close an InputStream. +

+ Equivalent to IOHelper.SafeURLInputStream.close(), except any exceptions will be ignored. + This is typically used in finally blocks. +

+

+
Parameters:
input - the InputStream to close, may be null or already closed
+
+
+
+ +

+closeQuietly

+
+public static void closeQuietly(java.io.OutputStream output)
+
+
Unconditionally close an OutputStream. +

+ Equivalent to OutputStream.close(), except any exceptions will be ignored. + This is typically used in finally blocks. +

+

+
Parameters:
output - the OutputStream to close, may be null or already closed
+
+
+
+ +

+copy

+
+public static int copy(java.io.InputStream input,
+                       java.io.OutputStream output)
+                throws java.io.IOException
+
+
Copy bytes from an InputStream to an + OutputStream. +

+ This method buffers the input internally, so there is no need to use a + BufferedInputStream. +

+

+
Parameters:
input - the InputStream to read from
output - the OutputStream to write to +
Returns:
the number of bytes copied +
Throws: +
java.lang.NullPointerException - if the input or output is null +
java.io.IOException - if an I/O error occurs
Since:
+
Commons IO 1.1
+
+
+
+
+ +

+getInputStream

+
+public static java.io.InputStream getInputStream(java.net.URL url)
+                                          throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-frame.html b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-frame.html new file mode 100644 index 0000000000..32b825be54 --- /dev/null +++ b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +org.apache.tuscany.sca.contribution.service.util + + + + + + + + + + + +org.apache.tuscany.sca.contribution.service.util + + + + +
+Classes  + +
+FileHelper +
+FileHelper.RegExpFilter +
+IOHelper +
+IOHelper.SafeURLInputStream
+ + + + diff --git a/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-summary.html b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-summary.html new file mode 100644 index 0000000000..92cbe7f93a --- /dev/null +++ b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-summary.html @@ -0,0 +1,167 @@ + + + + + + +org.apache.tuscany.sca.contribution.service.util + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package org.apache.tuscany.sca.contribution.service.util +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
FileHelper 
FileHelper.RegExpFilterA regular-expression based resource filter
IOHelper 
IOHelper.SafeURLInputStreamThis class is a workaround for URL stream issue as illustrated below.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-tree.html b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-tree.html new file mode 100644 index 0000000000..d5894d108e --- /dev/null +++ b/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/contribution/service/util/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tuscany.sca.contribution.service.util Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package org.apache.tuscany.sca.contribution.service.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + -- cgit v1.2.3