org.netbeans.lib.cvsclient.file

Class DefaultFileHandler

java.lang.Object

org.netbeans.lib.cvsclient.file.DefaultFileHandler

All Implemented Interfaces:

Serializable, FileHandler

Direct Known Subclasses:

GzippedFileHandler

public class DefaultFileHandler
extends Object
implements FileHandler

Provides a basic implementation of FileHandler, and does much of the handling of reading and writing files and performing CRLF conversions.

Author:

Robert Greig, James Carr

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultFileHandler() Creates a DefaultFileHandler.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyLocalFile(String pathname, String newName) Copy a local file to new destination.
protected boolean	createNewFile(File file) Extension point allowing subclasses to change file creation logic.
protected OutputStream	createOutputStream(File file) Extension point allowing subclasses to change file write logic.
Request[]	getInitialisationRequests() Get any requests that must be sent before commands are sent, to init this file handler.
protected String	getLengthString(long length) Get the string to transmit containing the file transmission length.
protected InputStream	getProcessedInputStream(File file)
protected Reader	getProcessedReader(File f)
TransmitTextFilePreprocessor	getTransmitTextFilePreprocessor() Returns the preprocessor for transmitting text files.
WriteTextFilePreprocessor	getWriteRcsDiffFilePreprocessor() Gets the preprocessor for merging text files after getting (and un-gzipping) the diff received from server.
WriteTextFilePreprocessor	getWriteTextFilePreprocessor() Gets the preprocessor for writing text files after getting (and un-gzipping) from server.
void	removeLocalFile(String pathname) Remove the specified file from the local disk.
protected void	setFileMode(String mode, File file)
void	setGlobalOptions(GlobalOptions globalOptions) Sets the global options.
void	setNextFileDate(Date modifiedDate) Set the modified date of the next file to be written.
void	setTransmitTextFilePreprocessor(TransmitTextFilePreprocessor transmitTextFilePreprocessor) Sets the preprocessor for transmitting text files.
void	setWriteRcsDiffFilePreprocessor(WriteTextFilePreprocessor writeRcsDiffFilePreprocessor) Sets the preprocessor for merging text files after getting (and un-gzipping) the diff received from server.
void	setWriteTextFilePreprocessor(WriteTextFilePreprocessor writeTextFilePreprocessor) Sets the preprocessor for writing text files after getting (and un-gzipping) from server.
void	transmitBinaryFile(File file, LoggedDataOutputStream dos) Transmit a binary file to the server, using the standard CVS protocol conventions.
void	transmitTextFile(File file, LoggedDataOutputStream dos) Transmit a text file to the server, using the standard CVS protocol conventions.
void	writeBinaryFile(String path, String mode, LoggedDataInputStream dis, int length) Write (either create or replace) a binary file on the local machine with one read from the server.
void	writeRcsDiffFile(String path, String mode, LoggedDataInputStream dis, int length) Merge a text file on the local machine with the diff from the server.
void	writeTextFile(String path, String mode, LoggedDataInputStream dis, int length) Write (either create or replace) a file on the local machine with one read from the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFileHandler

public DefaultFileHandler()

Creates a DefaultFileHandler.

Method Detail

getTransmitTextFilePreprocessor

public TransmitTextFilePreprocessor getTransmitTextFilePreprocessor()

Returns the preprocessor for transmitting text files.

setTransmitTextFilePreprocessor

public void setTransmitTextFilePreprocessor(TransmitTextFilePreprocessor transmitTextFilePreprocessor)

Sets the preprocessor for transmitting text files. The default one changes all line endings to Unix-lineendings (cvs default).

getWriteTextFilePreprocessor

public WriteTextFilePreprocessor getWriteTextFilePreprocessor()

Gets the preprocessor for writing text files after getting (and un-gzipping) from server.

setWriteTextFilePreprocessor

public void setWriteTextFilePreprocessor(WriteTextFilePreprocessor writeTextFilePreprocessor)

Sets the preprocessor for writing text files after getting (and un-gzipping) from server.

getWriteRcsDiffFilePreprocessor

public WriteTextFilePreprocessor getWriteRcsDiffFilePreprocessor()

Gets the preprocessor for merging text files after getting (and un-gzipping) the diff received from server.

setWriteRcsDiffFilePreprocessor

public void setWriteRcsDiffFilePreprocessor(WriteTextFilePreprocessor writeRcsDiffFilePreprocessor)

Sets the preprocessor for merging text files after getting (and un-gzipping) the diff received from server.

getLengthString

protected String getLengthString(long length)

Get the string to transmit containing the file transmission length.

Parameters:

length - the amount of data that will be sent

Returns:

a String to transmit to the server (including carriage return)

getProcessedReader

protected Reader getProcessedReader(File f)
                             throws IOException

Throws:

IOException

getProcessedInputStream

protected InputStream getProcessedInputStream(File file)
                                       throws IOException

Throws:

IOException

getInitialisationRequests

public Request[] getInitialisationRequests()

Get any requests that must be sent before commands are sent, to init this file handler.

Specified by:

getInitialisationRequests in interface FileHandler

Returns:

an array of Requests that must be sent

transmitTextFile

public void transmitTextFile(File file,
                    LoggedDataOutputStream dos)
                      throws IOException

Transmit a text file to the server, using the standard CVS protocol conventions. CR/LFs are converted to the Unix format.

Specified by:

transmitTextFile in interface FileHandler

Parameters:

file - the file to transmit

dos - the data outputstream on which to transmit the file

Throws:

IOException

transmitBinaryFile

public void transmitBinaryFile(File file,
                      LoggedDataOutputStream dos)
                        throws IOException

Transmit a binary file to the server, using the standard CVS protocol conventions.

Specified by:

transmitBinaryFile in interface FileHandler

Parameters:

file - the file to transmit

dos - the data outputstream on which to transmit the file

Throws:

IOException

writeTextFile

public void writeTextFile(String path,
                 String mode,
                 LoggedDataInputStream dis,
                 int length)
                   throws IOException

Write (either create or replace) a file on the local machine with one read from the server.

Specified by:

writeTextFile in interface FileHandler

Parameters:

path - the absolute path of the file, (including the file name).

mode - the mode of the file

dis - the stream to read the file from, as bytes

length - the number of bytes to read

Throws:

IOException

writeRcsDiffFile

public void writeRcsDiffFile(String path,
                    String mode,
                    LoggedDataInputStream dis,
                    int length)
                      throws IOException

Merge a text file on the local machine with the diff from the server. (it uses the RcsDiff response format - see cvsclient.ps for details)

Specified by:

writeRcsDiffFile in interface FileHandler

Parameters:

path - the absolute path of the file, (including the file name).

mode - the mode of the file

dis - the stream to read the file from, as bytes

length - the number of bytes to read

Throws:

IOException

writeBinaryFile

public void writeBinaryFile(String path,
                   String mode,
                   LoggedDataInputStream dis,
                   int length)
                     throws IOException

Write (either create or replace) a binary file on the local machine with one read from the server.

Specified by:

writeBinaryFile in interface FileHandler

Parameters:

path - the absolute path of the file, (including the file name).

mode - the mode of the file

dis - the stream to read the file from, as bytes

length - the number of bytes to read

Throws:

IOException

createNewFile

protected boolean createNewFile(File file)
                         throws IOException

Extension point allowing subclasses to change file creation logic.

Throws:

IOException

createOutputStream

protected OutputStream createOutputStream(File file)
                                   throws IOException

Extension point allowing subclasses to change file write logic. The stream is close()d after usage.

Throws:

IOException

removeLocalFile

public void removeLocalFile(String pathname)
                     throws IOException

Remove the specified file from the local disk.

Specified by:

removeLocalFile in interface FileHandler

Parameters:

pathname - the full path to the file to remove

Throws:

IOException - if an IO error occurs while removing the file

copyLocalFile

public void copyLocalFile(String pathname,
                 String newName)
                   throws IOException

Description copied from interface: FileHandler

Copy a local file to new destination. If the destination file exists, the file is overwritten.

Specified by:

copyLocalFile in interface FileHandler

Parameters:

pathname - the full path to the file to copy

newName - the new name of the file's copy (not the full path)

Throws:

IOException - if an IO error occurs while copying the file

setNextFileDate

public void setNextFileDate(Date modifiedDate)

Set the modified date of the next file to be written. The next call to writeFile will use this date.

Specified by:

setNextFileDate in interface FileHandler

Parameters:

modifiedDate - the date the file should be marked as modified

setGlobalOptions

public void setGlobalOptions(GlobalOptions globalOptions)

Sets the global options. This can be useful to detect, whether local files should be made read-only.

Specified by:

setGlobalOptions in interface FileHandler

setFileMode

protected void setFileMode(String mode,
               File file)