Class IOGroovyMethods
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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionstatic voideachByte(InputStream is, int bufferLen, Closure closure) Traverse through each the specified stream reading bytes into a buffer and calling the 2 parameter closure with this buffer and the number of bytes.static voideachByte(InputStream is, Closure closure) Traverse through each byte of the specified stream.static <T> TeachLine(InputStream stream, int firstLine, Closure<T> closure) Iterates through this stream, passing each line to the given 1 or 2 arg closure.static <T> TeachLine(InputStream stream, Closure<T> closure) Iterates through this stream, passing each line to the given 1 or 2 arg closure.static <T> TeachLine(InputStream stream, String charset, int firstLine, Closure<T> closure) Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure.static <T> TeachLine(InputStream stream, String charset, Closure<T> closure) Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure.static <T> TIterates through the given reader line by line.static <T> TIterates through the given reader line by line.static voideachObject(ObjectInputStream ois, Closure closure) Iterates through the given object stream object by object.static WritablefilterLine(InputStream self, Closure predicate) Filter lines from an input stream using a closure predicate.static voidfilterLine(InputStream self, Writer writer, Closure predicate) Uses a closure to filter lines from this InputStream and pass them to the given writer.static voidfilterLine(InputStream self, Writer writer, String charset, Closure predicate) Uses a closure to filter lines from this InputStream and pass them to the given writer.static WritablefilterLine(InputStream self, String charset, Closure predicate) Filter lines from an input stream using a closure predicate.static WritablefilterLine(Reader reader, Closure closure) Filter the lines from this Reader, and return a Writable which can be used to stream the filtered lines to a destination.static voidfilterLine(Reader reader, Writer writer, Closure closure) Filter the lines from a reader and write them on the writer, according to a closure which returns true if the line should be included.static byte[]getBytes(InputStream is) Read the content of this InputStream and return it as a byte[].static StringgetText(BufferedReader reader) Read the content of the BufferedReader and return it as a String.static StringgetText(InputStream is) Read the content of this InputStream and return it as a String.static StringgetText(InputStream is, String charset) Read the content of this InputStream using specified charset and return it as a String.static StringRead the content of the Reader and return it as a String.iterator(DataInputStream self) Standard iterator for a data input stream which iterates through the stream content a Byte at a time.iterator(InputStream self) Standard iterator for an input stream which iterates through the stream content in a byte-based fashion.Creates an iterator which will traverse through the reader a line at a time.static voidleftShift(ObjectOutputStream self, Object value) Overloads the leftShift operator to add objects to an ObjectOutputStream.static OutputStreamleftShift(OutputStream self, byte[] value) Overloads the leftShift operator to provide an append mechanism to add bytes to a stream.static OutputStreamleftShift(OutputStream self, InputStream in) Pipe an InputStream into an OutputStream for efficient stream copying.static WriterleftShift(OutputStream self, Object value) Overloads the leftShift operator to provide an append mechanism to add values to a stream.static WriterOverloads the leftShift operator for Writer to allow an object to be written using Groovy's default representation for the object.static AppendableleftShift(Appendable self, Object value) Overloads the leftShift operator for Appendable to allow an object to be appended using Groovy's default representation for the object.static ObjectInputStreamnewObjectInputStream(InputStream inputStream) Create an object input stream for this input stream.static ObjectInputStreamnewObjectInputStream(InputStream inputStream, ClassLoader classLoader) Create an object input stream for this input stream using the given class loader.static ObjectOutputStreamnewObjectOutputStream(OutputStream outputStream) Create an object output stream for this output stream.static PrintWriternewPrintWriter(OutputStream stream) Create a new PrintWriter for this OutputStream.static PrintWriternewPrintWriter(Writer writer) Create a new PrintWriter for this Writer.static BufferedReadernewReader(InputStream self) Creates a reader for this input stream.static BufferedReadernewReader(InputStream self, String charset) Creates a reader for this input stream, using the specified charset as the encoding.static WriternewWriter(OutputStream stream) Creates a writer for this stream.static WriternewWriter(OutputStream stream, String charset) Creates a writer for this stream using the given charset.static StringRead a single, whole line from the given Reader.readLines(InputStream stream) Reads the stream into a list, with one element for each line.readLines(InputStream stream, String charset) Reads the stream into a list, with one element for each line.Reads the reader into a list of Strings, with one entry for each line.static voidsetBytes(OutputStream os, byte[] bytes) Write the byte[] to the output stream.static <T> TsplitEachLine(InputStream stream, String regex, Closure<T> closure) Iterates through the given InputStream line by line, splitting each line using the given separator.static <T> TsplitEachLine(InputStream stream, String regex, String charset, Closure<T> closure) Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator.static <T> TsplitEachLine(InputStream stream, Pattern pattern, Closure<T> closure) Iterates through the given InputStream line by line, splitting each line using the given separator Pattern.static <T> TsplitEachLine(InputStream stream, Pattern pattern, String charset, Closure<T> closure) Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator Pattern.static <T> TsplitEachLine(Reader self, String regex, Closure<T> closure) Iterates through the given reader line by line, splitting each line using the given regex separator.static <T> TsplitEachLine(Reader self, Pattern pattern, Closure<T> closure) Iterates through the given reader line by line, splitting each line using the given regex separator Pattern.static voidtransformChar(Reader self, Writer writer, Closure closure) Transforms each character from this reader by passing it to the given closure.static voidtransformLine(Reader reader, Writer writer, Closure closure) Transforms the lines from a reader with a Closure and write them to a writer.static <T,U extends Closeable> 
 TwithCloseable(U self, Closure<T> action) Allows this closeable to be used within the closure, ensuring that it is closed once the closure has been executed and before this method returns.static AppendablewithFormatter(Appendable self, Closure closure) Invokes a Closure that uses a Formatter taking care of resource handling.static AppendablewithFormatter(Appendable self, Locale locale, Closure closure) Invokes a Closure that uses a Formatter taking care of resource handling.static <T> TwithObjectInputStream(InputStream inputStream, Closure<T> closure) Create a new ObjectInputStream for this input stream and pass it to the closure.static <T> TwithObjectInputStream(InputStream inputStream, ClassLoader classLoader, Closure<T> closure) Create a new ObjectInputStream for this input stream and pass it to the closure.static <T> TwithObjectOutputStream(OutputStream outputStream, Closure<T> closure) Create a new ObjectOutputStream for this output stream and then pass it to the closure.static <T> TwithPrintWriter(OutputStream stream, Closure<T> closure) Create a new PrintWriter for this OutputStream.static <T> TwithPrintWriter(Writer writer, Closure<T> closure) Create a new PrintWriter for this Writer.static <T> TwithReader(InputStream in, Closure<T> closure) Helper method to create a new Reader for a stream and then passes it into the closure.static <T> TwithReader(InputStream in, String charset, Closure<T> closure) Helper method to create a new Reader for a stream and then passes it into the closure.static <T> TwithReader(Reader reader, Closure<T> closure) Allows this reader to be used within the closure, ensuring that it is closed before this method returns.static <T,U extends InputStream> 
 TwithStream(U stream, Closure<T> closure) Allows this input stream to be used within the closure, ensuring that it is flushed and closed before this method returns.static <T> TwithWriter(OutputStream stream, Closure<T> closure) Creates a writer from this stream, passing it to the given closure.static <T> TwithWriter(OutputStream stream, String charset, Closure<T> closure) Creates a writer from this stream, passing it to the given closure.static <T> TwithWriter(Writer writer, Closure<T> closure) Allows this writer to be used within the closure, ensuring that it is flushed and closed before this method returns.static voidA helper method so that dynamic dispatch of the writer.write(object) method will always use the more efficient Writable.writeTo(writer) mechanism if the object implements the Writable interface.static voidwriteLine(BufferedWriter writer, String line) Write the text and append a newline (using the platform's line-ending).Methods inherited from class org.codehaus.groovy.runtime.DefaultGroovyMethodsSupportcloneSimilarCollection, cloneSimilarMap, closeQuietly, closeWithWarning, createSimilarArray, createSimilarCollection, createSimilarCollection, createSimilarCollection, createSimilarList, createSimilarMap, createSimilarOrDefaultCollection, createSimilarQueue, createSimilarSet, normaliseIndex, sameType, subListBorders, subListBorders, subListRange, writeUTF16BomIfRequired, writeUTF16BomIfRequired, writeUTF16BomIfRequired, writeUTF16BomIfRequired
- 
Constructor Details- 
IOGroovyMethodspublic IOGroovyMethods()
 
- 
- 
Method Details- 
leftShiftOverloads the leftShift operator for Writer to allow an object to be written using Groovy's default representation for the object.- Parameters:
- self- a Writer
- value- an Object whose default representation will be written to the Writer
- Returns:
- the writer on which this operation was invoked
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 1.0
 
- 
leftShiftOverloads the leftShift operator for Appendable to allow an object to be appended using Groovy's default representation for the object.- Parameters:
- self- an Appendable
- value- an Object whose default representation will be appended to the Appendable
- Returns:
- the Appendable on which this operation was invoked
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 2.1.0
 
- 
withFormatterInvokes a Closure that uses a Formatter taking care of resource handling. A Formatter is created and passed to the Closure as its argument. After the Closure executes, the Formatter is flushed and closed releasing any associated resources.- Parameters:
- self- an Appendable
- closure- a 1-arg Closure which will be called with a Formatter as its argument
- Returns:
- the Appendable on which this operation was invoked
- Since:
- 2.1.0
 
- 
withFormatterInvokes a Closure that uses a Formatter taking care of resource handling. A Formatter is created using the given Locale and passed to the Closure as its argument. After the Closure executes, the Formatter is flushed and closed releasing any associated resources.- Parameters:
- self- an Appendable
- locale- a Locale used when creating the Formatter
- closure- a 1-arg Closure which will be called with a Formatter as its argument
- Returns:
- the Appendable on which this operation was invoked
- Since:
- 2.1.0
 
- 
writeA helper method so that dynamic dispatch of the writer.write(object) method will always use the more efficient Writable.writeTo(writer) mechanism if the object implements the Writable interface.- Parameters:
- self- a Writer
- writable- an object implementing the Writable interface
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 1.0
 
- 
leftShiftOverloads the leftShift operator to provide an append mechanism to add values to a stream.- Parameters:
- self- an OutputStream
- value- a value to append
- Returns:
- a Writer
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 1.0
 
- 
leftShiftOverloads the leftShift operator to add objects to an ObjectOutputStream.- Parameters:
- self- an ObjectOutputStream
- value- an object to write to the stream
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 1.5.0
 
- 
leftShiftPipe an InputStream into an OutputStream for efficient stream copying.- Parameters:
- self- stream on which to write
- in- stream to read from
- Returns:
- the outputstream itself
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 1.0
 
- 
leftShiftOverloads the leftShift operator to provide an append mechanism to add bytes to a stream.- Parameters:
- self- an OutputStream
- value- a value to append
- Returns:
- an OutputStream
- Throws:
- IOException- if an I/O error occurs.
- Since:
- 1.0
 
- 
newObjectOutputStreampublic static ObjectOutputStream newObjectOutputStream(OutputStream outputStream) throws IOException Create an object output stream for this output stream.- Parameters:
- outputStream- an output stream
- Returns:
- an object output stream
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.0
 
- 
withObjectOutputStreampublic static <T> T withObjectOutputStream(OutputStream outputStream, Closure<T> closure) throws IOException Create a new ObjectOutputStream for this output stream and then pass it to the closure. This method ensures the stream is closed after the closure returns.- Parameters:
- outputStream- am output stream
- closure- a closure
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.0
- See Also:
 
- 
newObjectInputStreamCreate an object input stream for this input stream.- Parameters:
- inputStream- an input stream
- Returns:
- an object input stream
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.0
 
- 
newObjectInputStreampublic static ObjectInputStream newObjectInputStream(InputStream inputStream, ClassLoader classLoader) throws IOException Create an object input stream for this input stream using the given class loader.- Parameters:
- inputStream- an input stream
- classLoader- the class loader to use when loading the class
- Returns:
- an object input stream
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.0
 
- 
eachObjectpublic static void eachObject(ObjectInputStream ois, Closure closure) throws IOException, ClassNotFoundException Iterates through the given object stream object by object. The ObjectInputStream is closed afterwards.- Parameters:
- ois- an ObjectInputStream, closed after the operation
- closure- a closure
- Throws:
- IOException- if an IOException occurs.
- ClassNotFoundException- if the class is not found.
- Since:
- 1.0
 
- 
withObjectInputStreampublic static <T> T withObjectInputStream(InputStream inputStream, Closure<T> closure) throws IOException Create a new ObjectInputStream for this input stream and pass it to the closure. This method ensures the stream is closed after the closure returns.- Parameters:
- inputStream- an input stream
- closure- a closure
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.0
- See Also:
 
- 
withObjectInputStreampublic static <T> T withObjectInputStream(InputStream inputStream, ClassLoader classLoader, Closure<T> closure) throws IOException Create a new ObjectInputStream for this input stream and pass it to the closure. This method ensures the stream is closed after the closure returns.- Parameters:
- inputStream- an input stream
- classLoader- the class loader to use when loading the class
- closure- a closure
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.0
- See Also:
 
- 
eachLinepublic static <T> T eachLine(InputStream stream, String charset, Closure<T> closure) throws IOException Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.- Parameters:
- stream- a stream
- charset- opens the stream with a specified charset
- closure- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.5
- See Also:
 
- 
eachLinepublic static <T> T eachLine(InputStream stream, String charset, int firstLine, Closure<T> closure) throws IOException Iterates through this stream reading with the provided charset, passing each line to the given 1 or 2 arg closure. The stream is closed after this method returns.- Parameters:
- stream- a stream
- charset- opens the stream with a specified charset
- firstLine- 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)
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.7
- See Also:
 
- 
eachLineIterates through this stream, passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.- Parameters:
- stream- a stream
- closure- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.6
- See Also:
 
- 
eachLinepublic static <T> T eachLine(InputStream stream, int firstLine, Closure<T> closure) throws IOException Iterates through this stream, passing each line to the given 1 or 2 arg closure. The stream is closed before this method returns.- Parameters:
- stream- a stream
- firstLine- 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)
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.7
- See Also:
 
- 
eachLineIterates through the given reader line by line. Each line is passed to the given 1 or 2 arg closure. If the closure has two arguments, the line count is passed as the second argument. The Reader is closed before this method returns.- Parameters:
- self- a Reader, closed after the method returns
- closure- a closure (arg 1 is line, optional arg 2 is line number starting at line 1)
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.6
- See Also:
 
- 
eachLineIterates through the given reader line by line. Each line is passed to the given 1 or 2 arg closure. If the closure has two arguments, the line count is passed as the second argument. The Reader is closed before this method returns.- Parameters:
- self- a Reader, closed after the method returns
- firstLine- the line number value used for the first line (default is 1, set to 0 to start counting from 0)
- closure- a closure which will be passed each line (or for 2 arg closures the line and line count)
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.7
 
- 
splitEachLineIterates through the given reader line by line, splitting each line using the given regex separator. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. The Reader is closed afterwards.Here is an example: def s = 'The 3 quick\nbrown 4 fox' def result = '' new StringReader(s).splitEachLine(/\d/){ parts->result += "${parts[0]}_${parts[1]}|" } assert result == 'The _ quick|brown _ fox|'- Parameters:
- self- a Reader, closed after the method returns
- regex- the delimiting regular expression
- closure- a closure
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- PatternSyntaxException- if the regular expression's syntax is invalid
- Since:
- 1.5.5
- See Also:
 
- 
splitEachLinepublic static <T> T splitEachLine(Reader self, Pattern pattern, Closure<T> closure) throws IOException Iterates through the given reader line by line, splitting each line using the given regex separator Pattern. For each line, the given closure is called with a single parameter being the list of strings computed by splitting the line around matches of the given regular expression. The Reader is closed afterwards.Here is an example: def s = 'The 3 quick\nbrown 4 fox' def result = '' new StringReader(s).splitEachLine(~/\d/){ parts->result += "${parts[0]}_${parts[1]}|" } assert result == 'The _ quick|brown _ fox|'- Parameters:
- self- a Reader, closed after the method returns
- pattern- the regular expression Pattern for the delimiter
- closure- a closure
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- PatternSyntaxException- if the regular expression's syntax is invalid
- Since:
- 1.6.8
- See Also:
 
- 
splitEachLinepublic static <T> T splitEachLine(InputStream stream, String regex, String charset, Closure<T> closure) throws IOException Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator. The list of tokens for each line is then passed to the given closure. Finally, the stream is closed.- Parameters:
- stream- an InputStream
- regex- the delimiting regular expression
- charset- opens the stream with a specified charset
- closure- a closure
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- PatternSyntaxException- if the regular expression's syntax is invalid
- Since:
- 1.5.5
- See Also:
 
- 
splitEachLinepublic static <T> T splitEachLine(InputStream stream, Pattern pattern, String charset, Closure<T> closure) throws IOException Iterates through the given InputStream line by line using the specified encoding, splitting each line using the given separator Pattern. The list of tokens for each line is then passed to the given closure. Finally, the stream is closed.- Parameters:
- stream- an InputStream
- pattern- the regular expression Pattern for the delimiter
- charset- opens the stream with a specified charset
- closure- a closure
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.6.8
- See Also:
 
- 
splitEachLinepublic static <T> T splitEachLine(InputStream stream, String regex, Closure<T> closure) throws IOException Iterates through the given InputStream line by line, splitting each line using the given separator. The list of tokens for each line is then passed to the given closure. The stream is closed before the method returns.- Parameters:
- stream- an InputStream
- regex- the delimiting regular expression
- closure- a closure
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- PatternSyntaxException- if the regular expression's syntax is invalid
- Since:
- 1.5.6
- See Also:
 
- 
splitEachLinepublic static <T> T splitEachLine(InputStream stream, Pattern pattern, Closure<T> closure) throws IOException Iterates through the given InputStream line by line, splitting each line using the given separator Pattern. The list of tokens for each line is then passed to the given closure. The stream is closed before the method returns.- Parameters:
- stream- an InputStream
- pattern- the regular expression Pattern for the delimiter
- closure- a closure
- Returns:
- the last value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.6.8
- See Also:
 
- 
readLineRead a single, whole line from the given Reader. This method is designed for use with Readers that support themark()operation like BufferReader. It has a fallback behavior for Readers that don't support mark() but the behavior doesn't correctly detect multi-character line termination (e.g. carriage return followed by linefeed). We recommend for Readers that don't support mark() you consider using one of the following methods instead: eachLine, readLines, or iterator.- Parameters:
- self- a Reader
- Returns:
- a line
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
- See Also:
 
- 
readLinesReads the stream into a list, with one element for each line.- Parameters:
- stream- a stream
- Returns:
- a List of lines
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
- See Also:
 
- 
readLinesReads the stream into a list, with one element for each line.- Parameters:
- stream- a stream
- charset- opens the stream with a specified charset
- Returns:
- a List of lines
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.6.8
- See Also:
 
- 
readLinesReads the reader into a list of Strings, with one entry for each line. The reader is closed before this method returns.- Parameters:
- reader- a Reader
- Returns:
- a List of lines
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
getTextRead the content of this InputStream and return it as a String. The stream is closed before this method returns.- Parameters:
- is- an input stream
- Returns:
- the text from that URL
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
getTextRead the content of this InputStream using specified charset and return it as a String. The stream is closed before this method returns.- Parameters:
- is- an input stream
- charset- opens the stream with a specified charset
- Returns:
- the text from that URL
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
getTextRead the content of the Reader and return it as a String. The reader is closed before this method returns.- Parameters:
- reader- a Reader whose content we want to read
- Returns:
- a String containing the content of the buffered reader
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
- See Also:
 
- 
getTextRead the content of the BufferedReader and return it as a String. The BufferedReader is closed afterwards.- Parameters:
- reader- a BufferedReader whose content we want to read
- Returns:
- a String containing the content of the buffered reader
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
getBytesRead the content of this InputStream and return it as a byte[]. The stream is closed before this method returns.- Parameters:
- is- an input stream
- Returns:
- the byte[] from that InputStream
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.7.1
 
- 
setBytesWrite the byte[] to the output stream. The stream is closed before this method returns.- Parameters:
- os- an output stream
- bytes- the byte[] to write to the output stream
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.7.1
 
- 
writeLineWrite the text and append a newline (using the platform's line-ending).- Parameters:
- writer- a BufferedWriter
- line- the line to write
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
iteratorCreates an iterator which will traverse through the reader a line at a time.- Parameters:
- self- a Reader object
- Returns:
- an Iterator for the Reader
- Since:
- 1.5.0
- See Also:
 
- 
iteratorStandard iterator for an input stream which iterates through the stream content in a byte-based fashion.- Parameters:
- self- an InputStream object
- Returns:
- an Iterator for the InputStream
- Since:
- 1.5.0
 
- 
iteratorStandard iterator for a data input stream which iterates through the stream content a Byte at a time.- Parameters:
- self- a DataInputStream object
- Returns:
- an Iterator for the DataInputStream
- Since:
- 1.5.0
 
- 
newReaderCreates a reader for this input stream.- Parameters:
- self- an input stream
- Returns:
- a reader
- Since:
- 1.0
 
- 
newReaderpublic static BufferedReader newReader(InputStream self, String charset) throws UnsupportedEncodingException Creates a reader for this input stream, using the specified charset as the encoding.- Parameters:
- self- an input stream
- charset- the charset for this input stream
- Returns:
- a reader
- Throws:
- UnsupportedEncodingException- if the encoding specified is not supported
- Since:
- 1.6.0
 
- 
newPrintWriterCreate a new PrintWriter for this Writer.- Parameters:
- writer- a Writer
- Returns:
- a PrintWriter
- Since:
- 1.6.0
 
- 
newPrintWriterCreate a new PrintWriter for this OutputStream.- Parameters:
- stream- an OutputStream
- Returns:
- a PrintWriter
- Since:
- 2.2.0
 
- 
withPrintWriterCreate a new PrintWriter for this Writer. The writer is passed to the closure, and will be closed before this method returns.- Parameters:
- writer- a writer
- closure- the closure to invoke with the PrintWriter
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.6.0
 
- 
withPrintWriterCreate a new PrintWriter for this OutputStream. The writer is passed to the closure, and will be closed before this method returns.- Parameters:
- stream- an OutputStream
- closure- the closure to invoke with the PrintWriter
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 2.2.0
 
- 
withWriterAllows this writer to be used within the closure, ensuring that it is flushed and closed before this method returns.- Parameters:
- writer- the writer which is used and then closed
- closure- the closure that the writer is passed into
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.2
 
- 
withReaderAllows this reader to be used within the closure, ensuring that it is closed before this method returns.- Parameters:
- reader- the reader which is used and then closed
- closure- the closure that the writer is passed into
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.2
 
- 
withStreampublic static <T,U extends InputStream> T withStream(U stream, Closure<T> closure) throws IOException Allows this input stream to be used within the closure, ensuring that it is flushed and closed before this method returns.- Parameters:
- stream- the stream which is used and then closed
- closure- the closure that the stream is passed into
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.2
 
- 
withReaderHelper method to create a new Reader for a stream and then passes it into the closure. The reader (and this stream) is closed after the closure returns.- Parameters:
- in- a stream
- closure- the closure to invoke with the InputStream
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.2
- See Also:
 
- 
withReaderpublic static <T> T withReader(InputStream in, String charset, Closure<T> closure) throws IOException Helper method to create a new Reader for a stream and then passes it into the closure. The reader (and this stream) is closed after the closure returns.- Parameters:
- in- a stream
- charset- the charset used to decode the stream
- closure- the closure to invoke with the reader
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.6
- See Also:
 
- 
withWriterCreates a writer from this stream, passing it to the given closure. This method ensures the stream is closed after the closure returns.- Parameters:
- stream- the stream which is used and then closed
- closure- the closure that the writer is passed into
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.2
- See Also:
 
- 
newWriterCreates a writer for this stream.- Parameters:
- stream- the stream which is used and then closed
- Returns:
- the newly created Writer
- Since:
- 2.2.0
 
- 
withWriterpublic static <T> T withWriter(OutputStream stream, String charset, Closure<T> closure) throws IOException Creates a writer from this stream, passing it to the given closure. This method ensures the stream is closed after the closure returns.- Parameters:
- stream- the stream which is used and then closed
- charset- the charset used
- closure- the closure that the writer is passed into
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.2
- See Also:
 
- 
newWriterpublic static Writer newWriter(OutputStream stream, String charset) throws UnsupportedEncodingException Creates a writer for this stream using the given charset.- Parameters:
- stream- the stream which is used and then closed
- charset- the charset used
- Returns:
- the newly created Writer
- Throws:
- UnsupportedEncodingException- if an encoding exception occurs.
- Since:
- 2.2.0
 
- 
withStreamPasses this OutputStream to the closure, ensuring that the stream is closed after the closure returns, regardless of errors.- Parameters:
- os- the stream which is used and then closed
- closure- the closure that the stream is passed into
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.2
 
- 
eachByteTraverse through each byte of the specified stream. The stream is closed after the closure returns.- Parameters:
- is- stream to iterate over, closed after the method call
- closure- closure to apply to each byte
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
eachByteTraverse through each the specified stream reading bytes into a buffer and calling the 2 parameter closure with this buffer and the number of bytes.- Parameters:
- is- stream to iterate over, closed after the method call.
- bufferLen- the length of the buffer to use.
- closure- a 2 parameter closure which is passed the byte[] and a number of bytes successfully read.
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.8
 
- 
transformCharTransforms each character from this reader by passing it to the given closure. The Closure should return each transformed character, which will be passed to the Writer. The reader and writer will both be closed before this method returns.- Parameters:
- self- a Reader object
- writer- a Writer to receive the transformed characters
- closure- a closure that performs the required transformation
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.5.0
 
- 
transformLineTransforms the lines from a reader with a Closure and write them to a writer. Both Reader and Writer are closed after the operation.- Parameters:
- reader- Lines of text to be transformed. Reader is closed afterwards.
- writer- Where transformed lines are written. Writer is closed afterwards.
- closure- Single parameter closure that is called to transform each line of text from the reader, before writing it to the writer.
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
filterLineFilter the lines from a reader and write them on the writer, according to a closure which returns true if the line should be included. Both Reader and Writer are closed after the operation.- Parameters:
- reader- a reader, closed after the call
- writer- a writer, closed after the call
- closure- the closure which returns booleans
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
 
- 
filterLineFilter the lines from this Reader, and return a Writable which can be used to stream the filtered lines to a destination. The closure should returntrueif the line should be passed to the writer.- Parameters:
- reader- this reader
- closure- a closure used for filtering
- Returns:
- a Writable which will use the closure to filter each line from the reader when the Writable#writeTo(Writer) is called.
- Since:
- 1.0
 
- 
filterLineFilter lines from an input stream using a closure predicate. The closure will be passed each line as a String, and it should returntrueif the line should be passed to the writer.- Parameters:
- self- an input stream
- predicate- a closure which returns boolean and takes a line
- Returns:
- a writable which writes out the filtered lines
- Since:
- 1.0
- See Also:
 
- 
filterLinepublic static Writable filterLine(InputStream self, String charset, Closure predicate) throws UnsupportedEncodingException Filter lines from an input stream using a closure predicate. The closure will be passed each line as a String, and it should returntrueif the line should be passed to the writer.- Parameters:
- self- an input stream
- charset- opens the stream with a specified charset
- predicate- a closure which returns boolean and takes a line
- Returns:
- a writable which writes out the filtered lines
- Throws:
- UnsupportedEncodingException- if the encoding specified is not supported
- Since:
- 1.6.8
- See Also:
 
- 
filterLinepublic static void filterLine(InputStream self, Writer writer, Closure predicate) throws IOException Uses a closure to filter lines from this InputStream and pass them to the given writer. The closure will be passed each line as a String, and it should returntrueif the line should be passed to the writer.- Parameters:
- self- the InputStream
- writer- a writer to write output to
- predicate- a closure which returns true if a line should be accepted
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.0
- See Also:
 
- 
filterLinepublic static void filterLine(InputStream self, Writer writer, String charset, Closure predicate) throws IOException Uses a closure to filter lines from this InputStream and pass them to the given writer. The closure will be passed each line as a String, and it should returntrueif the line should be passed to the writer.- Parameters:
- self- the InputStream
- writer- a writer to write output to
- charset- opens the stream with a specified charset
- predicate- a closure which returns true if a line should be accepted
- Throws:
- IOException- if an IOException occurs.
- Since:
- 1.6.8
- See Also:
 
- 
withCloseablepublic static <T,U extends Closeable> T withCloseable(U self, Closure<T> action) throws IOException Allows this closeable to be used within the closure, ensuring that it is closed once the closure has been executed and before this method returns.As with the try-with-resources statement, if multiple exceptions are thrown the exception from the closure will be returned and the exception from closing will be added as a suppressed exception. - Parameters:
- self- the Closeable
- action- the closure taking the Closeable as parameter
- Returns:
- the value returned by the closure
- Throws:
- IOException- if an IOException occurs.
- Since:
- 2.4.0
 
- 
withCloseablepublic static <T,U extends AutoCloseable> T withCloseable(U self, Closure<T> action) throws Exception Allows this AutoCloseable to be used within the closure, ensuring that it is closed once the closure has been executed and before this method returns.As with the try-with-resources statement, if multiple exceptions are thrown the exception from the closure will be returned and the exception from closing will be added as a suppressed exception. - Parameters:
- self- the AutoCloseable
- action- the closure taking the AutoCloseable as parameter
- Returns:
- the value returned by the closure
- Throws:
- Exception- if an Exception occurs.
- Since:
- 2.5.0
 
 
-