public class ResourceGroovyMethods extends DefaultGroovyMethodsSupport
public static T eachLine(InputStream self, Closure c)
provides a eachLine(Closure c)
method for InputStream
.
NOTE: While this class contains many 'public' static methods, it is primarily regarded as an internal class (its internal package name suggests this also). We value backwards compatibility of these methods when used within Groovy but value less backwards compatibility at the Java method call level. I.e. future versions of Groovy may remove or move a method call in this file but would normally aim to keep the method available from within Groovy.
Constructor and Description |
---|
ResourceGroovyMethods() |
Modifier and Type | Method and Description |
---|---|
static void |
append(File file,
byte[] bytes)
Append bytes to the end of a File.
|
static void |
append(File self,
InputStream stream)
Append binary data to the file.
|
static void |
append(File file,
Object text)
Append the text at the end of the File.
|
static void |
append(File file,
Object text,
String charset)
Append the text at the end of the File, using a specified encoding.
|
static void |
append(File file,
Reader reader)
Append the text supplied by the Writer at the end of the File.
|
static void |
append(File file,
Reader reader,
String charset)
Append the text supplied by the Reader at the end of the File, using a specified encoding.
|
static void |
append(File file,
Writer writer)
Append the text supplied by the Writer at the end of the File.
|
static void |
append(File file,
Writer writer,
String charset)
Append the text supplied by the Writer at the end of the File, using a specified encoding.
|
static <T> T |
asType(File f,
Class<T> c)
Converts this File to a
Writable or delegates to default
DefaultGroovyMethods.asType(java.lang.Object, java.lang.Class) . |
static File |
asWritable(File file)
Converts this File to a
Writable . |
static File |
asWritable(File file,
String encoding)
Allows a file to return a Writable implementation that can output itself
to a Writer stream.
|
static boolean |
deleteDir(File self)
Deletes a directory with all contained files and subdirectories.
|
static long |
directorySize(File self)
Calculates directory size as total size of all its files, recursively.
|
static void |
eachByte(File self,
Closure closure)
Traverse through each byte of this File
|
static void |
eachByte(File self,
int bufferLen,
Closure closure)
Traverse through the bytes of this File, bufferLen bytes at a time.
|
static void |
eachByte(URL url,
Closure closure)
Reads the InputStream from this URL, passing each byte to the given
closure.
|
static void |
eachByte(URL url,
int bufferLen,
Closure closure)
Reads the InputStream from this URL, passing a byte[] and a number of bytes
to the given closure.
|
static void |
eachDir(File self,
Closure closure)
Invokes the closure for each subdirectory in this directory,
ignoring regular files.
|
static void |
eachDirMatch(File self,
Object nameFilter,
Closure closure)
Invokes the closure for each subdirectory whose name (dir.name) matches the given nameFilter in the given directory
- calling the
DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. |
static void |
eachDirRecurse(File self,
Closure closure)
Invokes the closure for each descendant directory of this directory.
|
static void |
eachFile(File self,
Closure closure)
Invokes the closure for each 'child' file in this 'parent' folder/directory.
|
static void |
eachFile(File self,
FileType fileType,
Closure closure)
Invokes the closure for each 'child' file in this 'parent' folder/directory.
|
static void |
eachFileMatch(File self,
FileType fileType,
Object nameFilter,
Closure closure)
Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory
- calling the
DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. |
static void |
eachFileMatch(File self,
Object nameFilter,
Closure closure)
Invokes the closure for each file whose name (file.name) matches the given nameFilter in the given directory
- calling the
DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object) method to determine if a match occurs. |
static void |
eachFileRecurse(File self,
Closure closure)
Invokes the closure for each descendant file in this directory.
|
static void |
eachFileRecurse(File self,
FileType fileType,
Closure closure)
Invokes the closure for each descendant file in this directory.
|
static <T> T |
eachLine(File self,
Closure<T> closure)
Iterates through this file line by line.
|
static <T> T |
eachLine(File self,
int firstLine,
Closure<T> closure)
Iterates through this file line by line.
|
static <T> T |
eachLine(File self,
String charset,
Closure<T> closure)
Iterates through this file line by line.
|
static <T> T |
eachLine(File self,
String charset,
int firstLine,
Closure<T> closure)
Iterates through this file line by line.
|
static <T> T |
eachLine(URL url,
Closure<T> closure)
Iterates through the lines read from the URL's associated input stream passing each
line to the given 1 or 2 arg closure.
|
static <T> T |
eachLine(URL url,
int firstLine,
Closure<T> closure)
Iterates through the lines read from the URL's associated input stream passing each
line to the given 1 or 2 arg closure.
|
static <T> T |
eachLine(URL url,
String charset,
Closure<T> closure)
Iterates through the lines read from the URL's associated input stream passing each
line to the given 1 or 2 arg closure.
|
static <T> T |
eachLine(URL url,
String charset,
int firstLine,
Closure<T> closure)
Iterates through the lines read from the URL's associated input stream passing each
line to the given 1 or 2 arg closure.
|
static void |
eachObject(File self,
Closure closure)
Iterates through the given file object by object.
|
static Writable |
filterLine(File self,
Closure closure)
Filters the lines of a File and creates a Writable in return to
stream the filtered lines.
|
static Writable |
filterLine(File self,
String charset,
Closure closure)
Filters the lines of a File and creates a Writable in return to
stream the filtered lines.
|
static void |
filterLine(File self,
Writer writer,
Closure closure)
Filter the lines from this File, and write them to the given writer based
on the given closure predicate.
|
static void |
filterLine(File self,
Writer writer,
String charset,
Closure closure)
Filter the lines from this File, and write them to the given writer based
on the given closure predicate.
|
static Writable |
filterLine(URL self,
Closure predicate)
Filter lines from a URL using a closure predicate.
|
static Writable |
filterLine(URL self,
String charset,
Closure predicate)
Filter lines from a URL using a closure predicate.
|
static void |
filterLine(URL self,
Writer writer,
Closure predicate)
Uses a closure to filter lines from this URL and pass them to
the given writer.
|
static void |
filterLine(URL self,
Writer writer,
String charset,
Closure predicate)
Uses a closure to filter lines from this URL and pass them to
the given writer.
|
static byte[] |
getBytes(File file)
Read the content of the File and returns it as a byte[].
|
static byte[] |
getBytes(URL url)
Read the content of this URL and returns it as a byte[].
|
static String |
getText(File file)
Read the content of the File and returns it as a String.
|
static String |
getText(File file,
String charset)
Read the content of the File using the specified encoding and return it
as a String.
|
static String |
getText(URL url)
Read the content of this URL and returns it as a String.
|
static String |
getText(URL url,
Map parameters)
Read the content of this URL and returns it as a String.
|
static String |
getText(URL url,
Map parameters,
String charset)
Read the data from this URL and return it as a String.
|
static String |
getText(URL url,
String charset)
Read the data from this URL and return it as a String.
|
static File |
leftShift(File file,
byte[] bytes)
Write bytes to a File.
|
static File |
leftShift(File file,
InputStream data)
Append binary data to the file.
|
static File |
leftShift(File file,
Object text)
Write the text to the File.
|
static DataInputStream |
newDataInputStream(File file)
Create a data input stream for this file
|
static DataOutputStream |
newDataOutputStream(File file)
Creates a new data output stream for this file.
|
static BufferedInputStream |
newInputStream(File file)
Creates a buffered input stream for this file.
|
static BufferedInputStream |
newInputStream(URL url)
Creates a buffered input stream for this URL.
|
static BufferedInputStream |
newInputStream(URL url,
Map parameters)
Creates a buffered input stream for this URL.
|
static ObjectInputStream |
newObjectInputStream(File file)
Create an object input stream for this file.
|
static ObjectInputStream |
newObjectInputStream(File file,
ClassLoader classLoader)
Create an object input stream for this file using the given class loader.
|
static ObjectOutputStream |
newObjectOutputStream(File file)
Create an object output stream for this file.
|
static BufferedOutputStream |
newOutputStream(File file)
Create a buffered output stream for this file.
|
static PrintWriter |
newPrintWriter(File file)
Create a new PrintWriter for this file.
|
static PrintWriter |
newPrintWriter(File file,
String charset)
Create a new PrintWriter for this file, using specified
charset.
|
static BufferedReader |
newReader(File file)
Create a buffered reader for this file.
|
static BufferedReader |
newReader(File file,
String charset)
Create a buffered reader for this file, using the specified
charset as the encoding.
|
static BufferedReader |
newReader(URL url)
Creates a buffered reader for this URL.
|
static BufferedReader |
newReader(URL url,
Map parameters)
Creates a buffered reader for this URL.
|
static BufferedReader |
newReader(URL url,
Map parameters,
String charset)
Creates a buffered reader for this URL using the given encoding.
|
static BufferedReader |
newReader(URL url,
String charset)
Creates a buffered reader for this URL using the given encoding.
|
static BufferedWriter |
newWriter(File file)
Create a buffered writer for this file.
|
static BufferedWriter |
newWriter(File file,
boolean append)
Creates a buffered writer for this file, optionally appending to the
existing file content.
|
static BufferedWriter |
newWriter(File file,
String charset)
Creates a buffered writer for this file, writing data using the given
encoding.
|
static BufferedWriter |
newWriter(File file,
String charset,
boolean append)
Helper method to create a buffered writer for a file.
|
static byte[] |
readBytes(File file)
Reads the content of the file into a byte array.
|
static List<String> |
readLines(File file)
Reads the file into a list of Strings, with one item for each line.
|
static List<String> |
readLines(File file,
String charset)
Reads the file into a list of Strings, with one item for each line.
|
static List<String> |
readLines(URL self)
Reads the URL contents into a list, with one element for each line.
|
static List<String> |
readLines(URL self,
String charset)
Reads the URL contents into a list, with one element for each line.
|
static boolean |
renameTo(File self,
String newPathName)
Renames the file.
|
static void |
setBytes(File file,
byte[] bytes)
Write the bytes from the byte array to the File.
|
static void |
setText(File file,
String text)
Synonym for write(text) allowing file.text = 'foo'.
|
static void |
setText(File file,
String text,
String charset)
Synonym for write(text, charset) allowing:
|
static long |
size(File self)
Provide the standard Groovy
size() method for File . |
static <T> T |
splitEachLine(File self,
Pattern pattern,
Closure<T> closure)
Iterates through this file line by line, splitting each line using
the given separator Pattern.
|
static <T> T |
splitEachLine(File self,
Pattern pattern,
String charset,
Closure<T> closure)
Iterates through this file line by line, splitting each line using
the given regex separator Pattern.
|
static <T> T |
splitEachLine(File self,
String regex,
Closure<T> closure)
Iterates through this file line by line, splitting each line using
the given regex separator.
|
static <T> T |
splitEachLine(File self,
String regex,
String charset,
Closure<T> closure)
Iterates through this file line by line, splitting each line using
the given regex separator.
|
static <T> T |
splitEachLine(URL self,
Pattern pattern,
Closure<T> closure)
Iterates through the input stream associated with this URL line by line, splitting each line using
the given regex separator Pattern.
|
static <T> T |
splitEachLine(URL self,
Pattern pattern,
String charset,
Closure<T> closure)
Iterates through the input stream associated with this URL line by line, splitting each line using
the given regex separator Pattern.
|
static <T> T |
splitEachLine(URL self,
String regex,
Closure<T> closure)
Iterates through the input stream associated with this URL line by line, splitting each line using
the given regex separator.
|
static <T> T |
splitEachLine(URL self,
String regex,
String charset,
Closure<T> closure)
Iterates through the input stream associated with this URL line by line, splitting each line using
the given regex separator.
|
static URI |
toURI(CharSequence self)
Transforms a CharSequence representing a URI into a URI object.
|
static URI |
toURI(String self)
Transforms a String representing a URI into a URI object.
|
static URL |
toURL(CharSequence self)
Transforms a CharSequence representing a URL into a URL object.
|
static URL |
toURL(String self)
Transforms a String representing a URL into a URL object.
|
static void |
traverse(File self,
Closure closure)
Invokes the closure for each descendant file in this directory tree.
|
static void |
traverse(File self,
Map<String,Object> options)
Invokes the closure specified with key 'visit' in the options Map
for each descendant file in this directory tree.
|
static void |
traverse(File self,
Map<String,Object> options,
Closure closure)
Invokes
closure for each descendant file in this directory tree. |
static <T> T |
withDataInputStream(File file,
Closure<T> closure)
Create a new DataInputStream for this file and passes it into the closure.
|
static <T> T |
withDataOutputStream(File file,
Closure<T> closure)
Create a new DataOutputStream for this file and passes it into the closure.
|
static Object |
withInputStream(File file,
Closure closure)
Create a new InputStream for this file and passes it into the closure.
|
static <T> T |
withInputStream(URL url,
Closure<T> closure)
Creates a new InputStream for this URL and passes it into the closure.
|
static <T> T |
withObjectInputStream(File file,
ClassLoader classLoader,
Closure<T> closure)
Create a new ObjectInputStream for this file associated with the given class loader and pass it to the closure.
|
static <T> T |
withObjectInputStream(File file,
Closure<T> closure)
Create a new ObjectInputStream for this file and pass it to the closure.
|
static <T> T |
withObjectOutputStream(File file,
Closure<T> closure)
Create a new ObjectOutputStream for this file and then pass it to the
closure.
|
static Object |
withOutputStream(File file,
Closure closure)
Creates a new OutputStream for this file and passes it into the closure.
|
static <T> T |
withPrintWriter(File file,
Closure<T> closure)
Create a new PrintWriter for this file which is then
passed it into the given closure.
|
static <T> T |
withPrintWriter(File file,
String charset,
Closure<T> closure)
Create a new PrintWriter with a specified charset for
this file.
|
static <T> T |
withReader(File file,
Closure<T> closure)
Create a new BufferedReader for this file and then
passes it into the closure, ensuring the reader is closed after the
closure returns.
|
static <T> T |
withReader(File file,
String charset,
Closure<T> closure)
Create a new BufferedReader for this file using the specified charset and then
passes it into the closure, ensuring the reader is closed after the
closure returns.
|
static <T> T |
withReader(URL url,
Closure<T> closure)
Helper method to create a new BufferedReader for a URL and then
passes it to the closure.
|
static <T> T |
withReader(URL url,
String charset,
Closure<T> closure)
Helper method to create a new Reader for a URL and then
passes it to the closure.
|
static <T> T |
withWriter(File file,
Closure<T> closure)
Creates a new BufferedWriter for this file, passes it to the closure, and
ensures the stream is flushed and closed after the closure returns.
|
static <T> T |
withWriter(File file,
String charset,
Closure<T> closure)
Creates a new BufferedWriter for this file, passes it to the closure, and
ensures the stream is flushed and closed after the closure returns.
|
static <T> T |
withWriterAppend(File file,
Closure<T> closure)
Create a new BufferedWriter for this file in append mode.
|
static <T> T |
withWriterAppend(File file,
String charset,
Closure<T> closure)
Create a new BufferedWriter which will append to this
file.
|
static void |
write(File file,
String text)
Write the text to the File.
|
static void |
write(File file,
String text,
String charset)
Write the text to the File, using the specified encoding.
|
cloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorders
public static long size(File self)
size()
method for File
.self
- a file objectpublic static long directorySize(File self) throws IOException, IllegalArgumentException
self
- a file objectIOException
- if File object specified does not existIllegalArgumentException
- if the provided File object does not represent a directorypublic static ObjectOutputStream newObjectOutputStream(File file) throws IOException
file
- a fileIOException
- if an IOException occurs.public static <T> T withObjectOutputStream(File file, Closure<T> closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.OutputStream, groovy.lang.Closure)
public static ObjectInputStream newObjectInputStream(File file) throws IOException
file
- a fileIOException
- if an IOException occurs.public static ObjectInputStream newObjectInputStream(File file, ClassLoader classLoader) throws IOException
file
- a fileclassLoader
- the class loader to use when loading the classIOException
- if an IOException occurs.public static void eachObject(File self, Closure closure) throws IOException, ClassNotFoundException
self
- a Fileclosure
- a closureIOException
- if an IOException occurs.ClassNotFoundException
- if the class is not found.IOGroovyMethods.eachObject(java.io.ObjectInputStream, groovy.lang.Closure)
public static <T> T withObjectInputStream(File file, Closure<T> closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
public static <T> T withObjectInputStream(File file, ClassLoader classLoader, Closure<T> closure) throws IOException
file
- a FileclassLoader
- the class loader to use when loading the classclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
public static <T> T eachLine(File self, Closure<T> closure) throws IOException
self
- a Fileclosure
- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)IOException
- if an IOException occurs.eachLine(java.io.File, int, groovy.lang.Closure)
public static <T> T eachLine(File self, String charset, Closure<T> closure) throws IOException
self
- a Filecharset
- opens the file with a specified charsetclosure
- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)IOException
- if an IOException occurs.eachLine(java.io.File, java.lang.String, int, groovy.lang.Closure)
public static <T> T eachLine(File self, int firstLine, Closure<T> closure) throws IOException
self
- a FilefirstLine
- the line number value used for the first line (default is 1, set to 0 to start counting from 0)closure
- a closure (arg 1 is line, optional arg 2 is line number)IOException
- if an IOException occurs.IOGroovyMethods.eachLine(java.io.Reader, int, groovy.lang.Closure)
public static <T> T eachLine(File self, String charset, int firstLine, Closure<T> closure) throws IOException
self
- a Filecharset
- opens the file with a specified charsetfirstLine
- the line number value used for the first line (default is 1, set to 0 to start counting from 0)closure
- a closure (arg 1 is line, optional arg 2 is line number)IOException
- if an IOException occurs.IOGroovyMethods.eachLine(java.io.Reader, int, groovy.lang.Closure)
public static <T> T eachLine(URL url, Closure<T> closure) throws IOException
url
- a URL to open and readclosure
- a closure to apply on each line (arg 1 is line, optional arg 2 is line number starting at line 1)IOException
- if an IOException occurs.eachLine(java.net.URL, int, groovy.lang.Closure)
public static <T> T eachLine(URL url, int firstLine, Closure<T> closure) throws IOException
url
- a URL to open and readfirstLine
- the line number value used for the first line (default is 1, set to 0 to start counting from 0)closure
- a closure to apply on each line (arg 1 is line, optional arg 2 is line number)IOException
- if an IOException occurs.IOGroovyMethods.eachLine(java.io.InputStream, int, groovy.lang.Closure)
public static <T> T eachLine(URL url, String charset, Closure<T> closure) throws IOException
url
- a URL to open and readcharset
- opens the stream with a specified charsetclosure
- a closure to apply on each line (arg 1 is line, optional arg 2 is line number starting at line 1)IOException
- if an IOException occurs.eachLine(java.net.URL, java.lang.String, int, groovy.lang.Closure)
public static <T> T eachLine(URL url, String charset, int firstLine, Closure<T> closure) throws IOException
url
- a URL to open and readcharset
- opens the stream with a specified charsetfirstLine
- the line number value used for the first line (default is 1, set to 0 to start counting from 0)closure
- a closure to apply on each line (arg 1 is line, optional arg 2 is line number)IOException
- if an IOException occurs.IOGroovyMethods.eachLine(java.io.Reader, int, groovy.lang.Closure)
public static <T> T splitEachLine(File self, String regex, Closure<T> closure) throws IOException
self
- a Fileregex
- the delimiting regular expressionclosure
- a closureIOException
- if an IOException occurs.PatternSyntaxException
- if the regular expression's syntax is invalidIOGroovyMethods.splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
public static <T> T splitEachLine(File self, Pattern pattern, Closure<T> closure) throws IOException
self
- a Filepattern
- the regular expression Pattern for the delimiterclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
public static <T> T splitEachLine(File self, String regex, String charset, Closure<T> closure) throws IOException
self
- a Fileregex
- the delimiting regular expressioncharset
- opens the file with a specified charsetclosure
- a closureIOException
- if an IOException occurs.PatternSyntaxException
- if the regular expression's syntax is invalidIOGroovyMethods.splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
public static <T> T splitEachLine(File self, Pattern pattern, String charset, Closure<T> closure) throws IOException
self
- a Filepattern
- the regular expression Pattern for the delimitercharset
- opens the file with a specified charsetclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
public static <T> T splitEachLine(URL self, String regex, Closure<T> closure) throws IOException
self
- a URL to open and readregex
- the delimiting regular expressionclosure
- a closureIOException
- if an IOException occurs.PatternSyntaxException
- if the regular expression's syntax is invalidIOGroovyMethods.splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
public static <T> T splitEachLine(URL self, Pattern pattern, Closure<T> closure) throws IOException
self
- a URL to open and readpattern
- the regular expression Pattern for the delimiterclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
public static <T> T splitEachLine(URL self, String regex, String charset, Closure<T> closure) throws IOException
self
- a URL to open and readregex
- the delimiting regular expressioncharset
- opens the file with a specified charsetclosure
- a closureIOException
- if an IOException occurs.PatternSyntaxException
- if the regular expression's syntax is invalidIOGroovyMethods.splitEachLine(java.io.Reader, java.lang.String, groovy.lang.Closure)
public static <T> T splitEachLine(URL self, Pattern pattern, String charset, Closure<T> closure) throws IOException
self
- a URL to open and readpattern
- the regular expression Pattern for the delimitercharset
- opens the file with a specified charsetclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.splitEachLine(java.io.Reader, java.util.regex.Pattern, groovy.lang.Closure)
public static List<String> readLines(File file) throws IOException
file
- a FileIOException
- if an IOException occurs.IOGroovyMethods.readLines(java.io.Reader)
public static List<String> readLines(File file, String charset) throws IOException
file
- a Filecharset
- opens the file with a specified charsetIOException
- if an IOException occurs.IOGroovyMethods.readLines(java.io.Reader)
public static List<String> readLines(URL self) throws IOException
self
- a URLIOException
- if an IOException occurs.IOGroovyMethods.readLines(java.io.Reader)
public static List<String> readLines(URL self, String charset) throws IOException
self
- a URLcharset
- opens the URL with a specified charsetIOException
- if an IOException occurs.IOGroovyMethods.readLines(java.io.Reader)
public static String getText(File file, String charset) throws IOException
file
- the file whose content we want to readcharset
- the charset used to read the content of the fileIOException
- if an IOException occurs.public static String getText(File file) throws IOException
file
- the file whose content we want to readIOException
- if an IOException occurs.public static String getText(URL url) throws IOException
url
- URL to read content fromIOException
- if an IOException occurs.public static String getText(URL url, Map parameters) throws IOException
url
- URL to read content fromparameters
- connection parametersIOException
- if an IOException occurs.public static String getText(URL url, String charset) throws IOException
url
- URL to read content fromcharset
- opens the stream with a specified charsetIOException
- if an IOException occurs.URLConnection.getInputStream()
public static String getText(URL url, Map parameters, String charset) throws IOException
url
- URL to read content fromparameters
- connection parameterscharset
- opens the stream with a specified charsetIOException
- if an IOException occurs.URLConnection.getInputStream()
public static byte[] getBytes(File file) throws IOException
file
- the file whose content we want to readIOException
- if an IOException occurs.public static byte[] getBytes(URL url) throws IOException
url
- URL to read content fromIOException
- if an IOException occurs.public static void setBytes(File file, byte[] bytes) throws IOException
file
- the file to write tobytes
- the byte[] to write to the fileIOException
- if an IOException occurs.public static void write(File file, String text) throws IOException
file
- a Filetext
- the text to write to the FileIOException
- if an IOException occurs.public static void setText(File file, String text) throws IOException
file
- a Filetext
- the text to write to the FileIOException
- if an IOException occurs.write(java.io.File, java.lang.String)
public static void setText(File file, String text, String charset) throws IOException
myFile.setText('some text', charset)or with some help from
ExpandoMetaClass
, you could do something like:
myFile.metaClass.setText = { String s -> delegate.setText(s, 'UTF-8') } myfile.text = 'some text'
file
- A Filecharset
- The charset used when writing to the filetext
- The text to write to the FileIOException
- if an IOException occurs.write(java.io.File, java.lang.String, java.lang.String)
public static File leftShift(File file, Object text) throws IOException
file
- a Filetext
- the text to write to the FileIOException
- if an IOException occurs.public static File leftShift(File file, byte[] bytes) throws IOException
file
- a Filebytes
- the byte array to append to the end of the FileIOException
- if an IOException occurs.public static File leftShift(File file, InputStream data) throws IOException
append(java.io.File, java.io.InputStream)
file
- a Filedata
- an InputStream of data to write to the fileIOException
- if an IOException occurs.public static void write(File file, String text, String charset) throws IOException
file
- a Filetext
- the text to write to the Filecharset
- the charset usedIOException
- if an IOException occurs.public static void append(File file, Object text) throws IOException
file
- a Filetext
- the text to append at the end of the FileIOException
- if an IOException occurs.public static void append(File file, Reader reader) throws IOException
file
- a Filereader
- the Reader supplying the text to append at the end of the FileIOException
- if an IOException occurs.public static void append(File file, Writer writer) throws IOException
file
- a Filewriter
- the Writer supplying the text to append at the end of the FileIOException
- if an IOException occurs.public static void append(File file, byte[] bytes) throws IOException
file
- a Filebytes
- the byte array to append to the end of the FileIOException
- if an IOException occurs.public static void append(File self, InputStream stream) throws IOException
self
- a Filestream
- stream to read data from.IOException
- if an IOException occurs.public static void append(File file, Object text, String charset) throws IOException
file
- a Filetext
- the text to append at the end of the Filecharset
- the charset usedIOException
- if an IOException occurs.public static void append(File file, Writer writer, String charset) throws IOException
file
- a Filewriter
- the Writer supplying the text to append at the end of the Filecharset
- the charset usedIOException
- if an IOException occurs.public static void append(File file, Reader reader, String charset) throws IOException
file
- a Filereader
- the Reader supplying the text to append at the end of the Filecharset
- the charset usedIOException
- if an IOException occurs.public static void eachFile(File self, FileType fileType, Closure closure) throws FileNotFoundException, IllegalArgumentException
self
- a file objectfileType
- if normal files or directories or both should be processedclosure
- the closure to invokeFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directorypublic static void eachFile(File self, Closure closure) throws FileNotFoundException, IllegalArgumentException
self
- a File (that happens to be a folder/directory)closure
- a closure (first parameter is the 'child' file)FileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directoryFile.listFiles()
,
eachFile(java.io.File, groovy.io.FileType, groovy.lang.Closure)
public static void eachDir(File self, Closure closure) throws FileNotFoundException, IllegalArgumentException
self
- a File (that happens to be a folder/directory)closure
- a closure (first parameter is the subdirectory file)FileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directoryFile.listFiles()
,
eachFile(java.io.File, groovy.io.FileType, groovy.lang.Closure)
public static void eachFileRecurse(File self, FileType fileType, Closure closure) throws FileNotFoundException, IllegalArgumentException
self
- a file objectfileType
- if normal files or directories or both should be processedclosure
- the closure to invoke on each fileFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directorypublic static void traverse(File self, Map<String,Object> options, Closure closure) throws FileNotFoundException, IllegalArgumentException
closure
for each descendant file in this directory tree.
Sub-directories are recursively traversed as found.
The traversal can be adapted by providing various options in the options
Map according
to the following keys:FileType
enum to determine if normal files or directories or both are processedClosure
run before each directory is processed and optionally returning a FileVisitResult
value
which can be used to control subsequent processing.Closure
run after each directory is processed and optionally returning a FileVisitResult
value
which can be used to control subsequent processing.FileType.FILES
)DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method). If set,
only files/dirs which match are candidates for visiting.DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method). If set,
only files/dirs which match are candidates for visiting. (Must not be set if 'filter' is set)DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method).
If set, any candidates which match won't be visited.DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method).
If set, any candidates which match won't be visited. (Must not be set if 'excludeFilter' is set)Closure
which if set causes the files and subdirectories for each directory to be processed in sorted order.
Note that even when processing only files, the order of visited subdirectories will be affected by this parameter.def totalSize = 0 def count = 0 def sortByTypeThenName = { a, b -> a.isFile() != b.isFile() ? a.isFile() <=> b.isFile() : a.name <=> b.name } rootDir.traverse( type : FILES, nameFilter : ~/.*\.groovy/, preDir : { if (it.name == '.svn') return SKIP_SUBTREE }, postDir : { println "Found $count files in $it.name totalling $totalSize bytes" totalSize = 0; count = 0 }, postRoot : true sort : sortByTypeThenName ) {it -> totalSize += it.size(); count++ }
self
- a Fileoptions
- a Map of options to alter the traversal behaviorclosure
- the Closure to invoke on each file/directory and optionally returning a FileVisitResult
value
which can be used to control subsequent processingFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directory or illegal filter combinations are suppliedDefaultGroovyMethods.sort(java.util.Collection, groovy.lang.Closure)
,
FileVisitResult
,
FileType
public static void traverse(File self, Closure closure) throws FileNotFoundException, IllegalArgumentException
traverse(java.io.File, java.util.Map, groovy.lang.Closure)
when
no options to alter the traversal behavior are required.self
- a Fileclosure
- the Closure to invoke on each file/directory and optionally returning a FileVisitResult
value
which can be used to control subsequent processingFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directorytraverse(java.io.File, java.util.Map, groovy.lang.Closure)
public static void traverse(File self, Map<String,Object> options) throws FileNotFoundException, IllegalArgumentException
traverse(java.io.File, java.util.Map, groovy.lang.Closure)
allowing the 'visit' closure
to be included in the options Map rather than as a parameter.self
- a Fileoptions
- a Map of options to alter the traversal behaviorFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directory or illegal filter combinations are suppliedtraverse(java.io.File, java.util.Map, groovy.lang.Closure)
public static void eachFileRecurse(File self, Closure closure) throws FileNotFoundException, IllegalArgumentException
self
- a Fileclosure
- a closureFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directoryeachFileRecurse(java.io.File, groovy.io.FileType, groovy.lang.Closure)
public static void eachDirRecurse(File self, Closure closure) throws FileNotFoundException, IllegalArgumentException
self
- a directoryclosure
- a closureFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directoryeachFileRecurse(java.io.File, groovy.io.FileType, groovy.lang.Closure)
public static void eachFileMatch(File self, FileType fileType, Object nameFilter, Closure closure) throws FileNotFoundException, IllegalArgumentException
DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method to determine if a match occurs. This method can be used
with different kinds of filters like regular expressions, classes, ranges etc.
Both regular files and subdirectories may be candidates for matching depending
on the value of fileType.
// collect names of files in baseDir matching supplied regex pattern import static groovy.io.FileType.* def names = [] baseDir.eachFileMatch FILES, ~/foo\d\.txt/, { names << it.name } assert names == ['foo1.txt', 'foo2.txt'] // remove all *.bak files in baseDir baseDir.eachFileMatch FILES, ~/.*\.bak/, { File bak -> bak.delete() } // print out files > 4K in size from baseDir baseDir.eachFileMatch FILES, { new File(baseDir, it).size() > 4096 }, { println "$it.name ${it.size()}" }
self
- a filefileType
- whether normal files or directories or both should be processednameFilter
- the filter to perform on the name of the file/directory (using the DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method)closure
- the closure to invokeFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directorypublic static void eachFileMatch(File self, Object nameFilter, Closure closure) throws FileNotFoundException, IllegalArgumentException
DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method to determine if a match occurs. This method can be used
with different kinds of filters like regular expressions, classes, ranges etc.
Both regular files and subdirectories are matched.self
- a filenameFilter
- the nameFilter to perform on the name of the file (using the DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method)closure
- the closure to invokeFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directoryeachFileMatch(java.io.File, groovy.io.FileType, java.lang.Object, groovy.lang.Closure)
public static void eachDirMatch(File self, Object nameFilter, Closure closure) throws FileNotFoundException, IllegalArgumentException
DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method to determine if a match occurs. This method can be used
with different kinds of filters like regular expressions, classes, ranges etc.
Only subdirectories are matched; regular files are ignored.self
- a filenameFilter
- the nameFilter to perform on the name of the directory (using the DefaultGroovyMethods.isCase(java.lang.Object, java.lang.Object)
method)closure
- the closure to invokeFileNotFoundException
- if the given directory does not existIllegalArgumentException
- if the provided File object does not represent a directoryeachFileMatch(java.io.File, groovy.io.FileType, java.lang.Object, groovy.lang.Closure)
public static boolean deleteDir(File self)
The method returns
self
- a Filepublic static boolean renameTo(File self, String newPathName)
File.renameTo(File)
self
- a FilenewPathName
- The new pathname for the named filetrue
if and only if the renaming succeeded;
false
otherwisepublic static File asWritable(File file)
Writable
.file
- a Filepublic static <T> T asType(File f, Class<T> c)
Writable
or delegates to default
DefaultGroovyMethods.asType(java.lang.Object, java.lang.Class)
.f
- a Filec
- the desired classpublic static File asWritable(File file, String encoding)
file
- a Fileencoding
- the encoding to be used when reading the file's contentspublic static BufferedReader newReader(File file) throws IOException
file
- a FileIOException
- if an IOException occurs.public static BufferedReader newReader(File file, String charset) throws FileNotFoundException, UnsupportedEncodingException
file
- a Filecharset
- the charset for this FileFileNotFoundException
- if the File was not foundUnsupportedEncodingException
- if the encoding specified is not supportedpublic static <T> T withReader(File file, Closure<T> closure) throws IOException
file
- a file objectclosure
- a closureIOException
- if an IOException occurs.public static <T> T withReader(File file, String charset, Closure<T> closure) throws IOException
file
- a file objectcharset
- the charset for this input streamclosure
- a closureIOException
- if an IOException occurs.public static BufferedOutputStream newOutputStream(File file) throws IOException
file
- a file objectIOException
- if an IOException occurs.public static DataOutputStream newDataOutputStream(File file) throws IOException
file
- a file objectIOException
- if an IOException occurs.public static Object withOutputStream(File file, Closure closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.OutputStream, groovy.lang.Closure)
public static Object withInputStream(File file, Closure closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
public static <T> T withInputStream(URL url, Closure<T> closure) throws IOException
url
- a URLclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
public static <T> T withDataOutputStream(File file, Closure<T> closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.OutputStream, groovy.lang.Closure)
public static <T> T withDataInputStream(File file, Closure<T> closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.withStream(java.io.InputStream, groovy.lang.Closure)
public static BufferedWriter newWriter(File file) throws IOException
file
- a FileIOException
- if an IOException occurs.public static BufferedWriter newWriter(File file, boolean append) throws IOException
file
- a Fileappend
- true if data should be appended to the fileIOException
- if an IOException occurs.public static BufferedWriter newWriter(File file, String charset, boolean append) throws IOException
file
- a Filecharset
- the name of the encoding used to write in this fileappend
- true if in append modeIOException
- if an IOException occurs.public static BufferedWriter newWriter(File file, String charset) throws IOException
file
- a Filecharset
- the name of the encoding used to write in this fileIOException
- if an IOException occurs.public static <T> T withWriter(File file, Closure<T> closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.public static <T> T withWriter(File file, String charset, Closure<T> closure) throws IOException
file
- a Filecharset
- the charset usedclosure
- a closureIOException
- if an IOException occurs.public static <T> T withWriterAppend(File file, String charset, Closure<T> closure) throws IOException
file
- a Filecharset
- the charset usedclosure
- a closureIOException
- if an IOException occurs.public static <T> T withWriterAppend(File file, Closure<T> closure) throws IOException
file
- a Fileclosure
- a closureIOException
- if an IOException occurs.public static PrintWriter newPrintWriter(File file) throws IOException
file
- a FileIOException
- if an IOException occurs.public static PrintWriter newPrintWriter(File file, String charset) throws IOException
file
- a Filecharset
- the charsetIOException
- if an IOException occurs.public static <T> T withPrintWriter(File file, Closure<T> closure) throws IOException
file
- a Fileclosure
- the closure to invoke with the PrintWriterIOException
- if an IOException occurs.public static <T> T withPrintWriter(File file, String charset, Closure<T> closure) throws IOException
file
- a Filecharset
- the charsetclosure
- the closure to invoke with the PrintWriterIOException
- if an IOException occurs.public static <T> T withReader(URL url, Closure<T> closure) throws IOException
url
- a URLclosure
- the closure to invoke with the readerIOException
- if an IOException occurs.public static <T> T withReader(URL url, String charset, Closure<T> closure) throws IOException
url
- a URLcharset
- the charset usedclosure
- the closure to invoke with the readerIOException
- if an IOException occurs.public static BufferedInputStream newInputStream(File file) throws FileNotFoundException
file
- a FileFileNotFoundException
- if the file is not found.public static BufferedInputStream newInputStream(URL url) throws MalformedURLException, IOException
url
- a URLMalformedURLException
- is thrown if the URL is not well formedIOException
- if an I/O error occurs while creating the input streampublic static BufferedInputStream newInputStream(URL url, Map parameters) throws MalformedURLException, IOException
url
- a URLparameters
- connection parametersMalformedURLException
- is thrown if the URL is not well formedIOException
- if an I/O error occurs while creating the input streampublic static BufferedReader newReader(URL url) throws MalformedURLException, IOException
url
- a URLMalformedURLException
- is thrown if the URL is not well formedIOException
- if an I/O error occurs while creating the input streampublic static BufferedReader newReader(URL url, Map parameters) throws MalformedURLException, IOException
url
- a URLparameters
- connection parametersMalformedURLException
- is thrown if the URL is not well formedIOException
- if an I/O error occurs while creating the input streampublic static BufferedReader newReader(URL url, String charset) throws MalformedURLException, IOException
url
- a URLcharset
- opens the stream with a specified charsetMalformedURLException
- is thrown if the URL is not well formedIOException
- if an I/O error occurs while creating the input streampublic static BufferedReader newReader(URL url, Map parameters, String charset) throws MalformedURLException, IOException
url
- a URLparameters
- connection parameterscharset
- opens the stream with a specified charsetMalformedURLException
- is thrown if the URL is not well formedIOException
- if an I/O error occurs while creating the input streampublic static DataInputStream newDataInputStream(File file) throws FileNotFoundException
file
- a FileFileNotFoundException
- if the file is not found.public static void eachByte(File self, Closure closure) throws IOException
self
- a Fileclosure
- a closureIOException
- if an IOException occurs.IOGroovyMethods.eachByte(java.io.InputStream, groovy.lang.Closure)
public static void eachByte(File self, int bufferLen, Closure closure) throws IOException
self
- a FilebufferLen
- the length of the buffer to use.closure
- a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.IOException
- if an IOException occurs.IOGroovyMethods.eachByte(java.io.InputStream, int, groovy.lang.Closure)
public static void eachByte(URL url, Closure closure) throws IOException
url
- url to iterate overclosure
- closure to apply to each byteIOException
- if an IOException occurs.IOGroovyMethods.eachByte(java.io.InputStream, groovy.lang.Closure)
public static void eachByte(URL url, int bufferLen, Closure closure) throws IOException
url
- url to iterate overbufferLen
- the length of the buffer to use.closure
- a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.IOException
- if an IOException occurs.IOGroovyMethods.eachByte(java.io.InputStream, int, groovy.lang.Closure)
public static Writable filterLine(File self, Closure closure) throws IOException
self
- a Fileclosure
- a closure which returns a boolean indicating to filter
the line or notIOException
- if self
is not readableIOGroovyMethods.filterLine(java.io.Reader, groovy.lang.Closure)
public static Writable filterLine(File self, String charset, Closure closure) throws IOException
self
- a Filecharset
- opens the file with a specified charsetclosure
- a closure which returns a boolean indicating to filter
the line or notIOException
- if an IOException occursIOGroovyMethods.filterLine(java.io.Reader, groovy.lang.Closure)
public static void filterLine(File self, Writer writer, Closure closure) throws IOException
self
- a Filewriter
- a writer destination to write filtered lines toclosure
- a closure which takes each line as a parameter and returns
true
if the line should be written to this writer.IOException
- if self
is not readableIOGroovyMethods.filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
public static void filterLine(File self, Writer writer, String charset, Closure closure) throws IOException
self
- a Filewriter
- a writer destination to write filtered lines tocharset
- opens the file with a specified charsetclosure
- a closure which takes each line as a parameter and returns
true
if the line should be written to this writer.IOException
- if an IO error occursIOGroovyMethods.filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
public static Writable filterLine(URL self, Closure predicate) throws IOException
true
if the line should be passed to the writer.self
- a URLpredicate
- a closure which returns boolean and takes a lineIOException
- if an IO exception occursIOGroovyMethods.filterLine(java.io.Reader, groovy.lang.Closure)
public static Writable filterLine(URL self, String charset, Closure predicate) throws IOException
true
if the line should be passed to the writer.self
- the URLcharset
- opens the URL with a specified charsetpredicate
- a closure which returns boolean and takes a lineIOException
- if an IO exception occursIOGroovyMethods.filterLine(java.io.Reader, groovy.lang.Closure)
public static void filterLine(URL self, Writer writer, Closure predicate) throws IOException
true
if the line should be passed to the
writer.self
- the URLwriter
- a writer to write output topredicate
- a closure which returns true if a line should be acceptedIOException
- if an IOException occurs.IOGroovyMethods.filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
public static void filterLine(URL self, Writer writer, String charset, Closure predicate) throws IOException
true
if the line should be passed to the
writer.self
- the URLwriter
- a writer to write output tocharset
- opens the URL with a specified charsetpredicate
- a closure which returns true if a line should be acceptedIOException
- if an IOException occurs.IOGroovyMethods.filterLine(java.io.Reader, java.io.Writer, groovy.lang.Closure)
public static byte[] readBytes(File file) throws IOException
file
- a FileIOException
- if an IOException occurs.public static URI toURI(CharSequence self) throws URISyntaxException
self
- the CharSequence representing a URIURISyntaxException
- is thrown if the URI is not well formed.public static URI toURI(String self) throws URISyntaxException
self
- the String representing a URIURISyntaxException
- is thrown if the URI is not well formed.public static URL toURL(CharSequence self) throws MalformedURLException
self
- the CharSequence representing a URLMalformedURLException
- is thrown if the URL is not well formed.public static URL toURL(String self) throws MalformedURLException
self
- the String representing a URLMalformedURLException
- is thrown if the URL is not well formed.