Package com.sshtools.common.util

Class TextConversionStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.sshtools.common.util.TextConversionStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class TextConversionStream
extends FilterOutputStream

This class processes text data and corrects line endings according to the settings provided. Specifically you can set the input style to process so that lone \r and \n characters within a \r\n encoded file are written through without amendments (the SFTP protocol states that this must be the case when processing text files).

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TEXT_ALL	This input style instructs the conversion to strip all line ending type characters and replace with the output style line ending
static final int	TEXT_CR	This indicates a CR line ending style and can be used for either input or output style parameters
static final int	TEXT_CRLF
static final int	TEXT_DOS	This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.
static final int	TEXT_LF	This indicates a single LF line ending style and can be used for either input or output style parameters
static final int	TEXT_MAC	This indicates a MAC line ending and can be used in either the input or output style parameters
static final int	TEXT_SYSTEM	This output style specifies that the text will have line endings set to the current system setting.
static final int	TEXT_UNIX	This indicates a LF line ending style and can be used for either input or output style parameters
static final int	TEXT_WINDOWS	This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
TextConversionStream(int inputStyle, int outputStyle, OutputStream out)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasBinary()	Check to see if binary data was encountered during the encoding process
static void	main(String[] args)
void	write(byte[] buf, int off, int len)
void	write(int b)

Methods inherited from class java.io.FilterOutputStream

flush, write

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

Field Details

TEXT_SYSTEM

public static final int TEXT_SYSTEM

This output style specifies that the text will have line endings set to the current system setting.

See Also:

• Constant Field Values

TEXT_WINDOWS

public static final int TEXT_WINDOWS

This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.

See Also:

• Constant Field Values

TEXT_DOS

public static final int TEXT_DOS

This indicates a CRLF line ending combinarion and can be used for both input and output style parameters.

See Also:

• Constant Field Values

TEXT_CRLF

public static final int TEXT_CRLF

See Also:

• Constant Field Values

TEXT_UNIX

public static final int TEXT_UNIX

This indicates a LF line ending style and can be used for either input or output style parameters

See Also:

• Constant Field Values

TEXT_LF

public static final int TEXT_LF

This indicates a single LF line ending style and can be used for either input or output style parameters

See Also:

• Constant Field Values

TEXT_MAC

public static final int TEXT_MAC

This indicates a MAC line ending and can be used in either the input or output style parameters

See Also:

• Constant Field Values

TEXT_CR

public static final int TEXT_CR

This indicates a CR line ending style and can be used for either input or output style parameters

See Also:

• Constant Field Values

TEXT_ALL

public static final int TEXT_ALL

This input style instructs the conversion to strip all line ending type characters and replace with the output style line ending

See Also:

• Constant Field Values

Constructor Details

TextConversionStream

public TextConversionStream(int inputStyle,
 int outputStyle,
 OutputStream out)

Method Details

hasBinary

public boolean hasBinary()

Check to see if binary data was encountered during the encoding process

Returns:

boolean

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] buf,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterOutputStream

Parameters:

buf - byte[]

off - int

len - int

out - OutputStream

Throws:

IOException

main

public static void main(String[] args)