org.apache.tools.ant.module.spi

Class AntOutputStream

java.lang.Object

java.io.OutputStream

org.apache.tools.ant.module.spi.AntOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Deprecated.

This functionality is not recommended to be used and may result in loss of some Ant module features as of org.apache.tools.ant.module/3 3.12.

@Deprecated
public abstract class AntOutputStream
extends OutputStream

OutputStream for wrapping output of Ant task and capable of parsing Ant output.

Since:

2.15

Constructor Summary

Constructors

Constructor and Description
AntOutputStream() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
void	flush() Deprecated.
protected String	formatMessage(String fileName, String message, int line1, int col1, int line2, int col2) Deprecated. No longer used since org.apache.tools.ant.module/3 3.8.
protected void	handleClose() Deprecated. This method is called when the stream is closed and it allows entensions of this class to do additional tasks.
void	write(byte[] b) Deprecated.
void	write(byte[] b, int offset, int length) Deprecated.
void	write(int b) Deprecated.
protected abstract void	writeLine(String line) Deprecated. Write one line of text which was not parsed.
protected void	writeLine(String line, FileObject file, int line1, int col1, int line2, int col2, String message) Deprecated. Please override the variant taking URL instead, since org.apache.tools.ant.module/3 3.10.
protected boolean	writeLine(String line, URL file, int line1, int col1, int line2, int col2, String message) Deprecated. No longer called.

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AntOutputStream

public AntOutputStream()

Deprecated.

Method Detail

close

public final void close()
                 throws IOException

Deprecated.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

handleClose

protected void handleClose()
                    throws IOException

Deprecated.

This method is called when the stream is closed and it allows entensions of this class to do additional tasks. For example, closing an underlying stream, etc. The default implementation does nothing.

Throws:

IOException

flush

public final void flush()
                 throws IOException

Deprecated.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

public final void write(byte[] b)
                 throws IOException

Deprecated.

Overrides:

write in class OutputStream

Throws:

IOException

write

public final void write(byte[] b,
                        int offset,
                        int length)
                 throws IOException

Deprecated.

Overrides:

write in class OutputStream

Throws:

IOException

write

public final void write(int b)
                 throws IOException

Deprecated.

Specified by:

write in class OutputStream

Throws:

IOException

writeLine

@Deprecated
protected boolean writeLine(String line,
                                        URL file,
                                        int line1,
                                        int col1,
                                        int line2,
                                        int col2,
                                        String message)
                                 throws IOException

Deprecated. No longer called.

Write one line of the parsed text (must be overridden). All line and column parameters can be -1 meaning that the value was not available or parsing was not successful.

Parameters:

line - original text of the line

file - file location for which this line was generated

line1 - starting line of the message

col1 - starting column of the message

line2 - ending line of the message

col2 - ending column of the message

message - message

Returns:

must always return true

Throws:

IOException

Since:

org.apache.tools.ant.module/3 3.10

writeLine

@Deprecated
protected void writeLine(String line,
                                     FileObject file,
                                     int line1,
                                     int col1,
                                     int line2,
                                     int col2,
                                     String message)
                              throws IOException

Deprecated. Please override the variant taking URL instead, since org.apache.tools.ant.module/3 3.10.

Write one line of the parsed text. All line and column parameters can be -1 what means that value was not available or parsing was not successful.

Parameters:

line - original text of the line

file - file object for which this line was generated

line1 - starting line of the message

col1 - starting column of the message

line2 - ending line of the message

col2 - ending column of the message

message - message

Throws:

IOException

writeLine

protected abstract void writeLine(String line)
                           throws IOException

Deprecated.

Write one line of text which was not parsed.

Throws:

IOException

formatMessage

@Deprecated
protected String formatMessage(String fileName,
                                           String message,
                                           int line1,
                                           int col1,
                                           int line2,
                                           int col2)

Deprecated. No longer used since org.apache.tools.ant.module/3 3.8.

Create well formated message from the parsed information.