org.das2.util.filesystem

Interface WriteCapability

public interface WriteCapability

The FileObject can be written.

Method Summary

Modifier and Type	Method and Description
boolean	canWrite() Test to see if we can write to this file.
boolean	commit(java.lang.String message) push the changes to the remote server.
boolean	delete() delete the file
java.io.OutputStream	getOutputStream() Get the output stream.

Method Detail

getOutputStream

java.io.OutputStream getOutputStream()
                              throws java.io.IOException

Get the output stream. The client who has requested the stream must close the stream.

Returns:

Throws:

java.io.IOException

canWrite

boolean canWrite()

Test to see if we can write to this file. This should not create a file, only getOutputStream should do this. TODO: someday we'll want a locking mechanism.

Returns:

true if the file can be created.

delete

boolean delete()
        throws java.io.IOException

delete the file

Returns:

true if the file was deleted.

Throws:

java.io.IOException

commit

boolean commit(java.lang.String message)
        throws java.io.IOException

push the changes to the remote server. For local files, this does nothing, unless it is a local git repository.

Parameters:

message - message to document the commit.

Returns:

true if the commit was successful, false if not.

Throws:

java.io.IOException