com.google.caja.ancillary.jsdoc
Interface FileSystem

All Known Implementing Classes:
JsdocMain.RealFileSystem, JsdocMain.RestrictedFileSystem, JsdocMainTest.FakeFileSystem, ZipFileSystem

public interface FileSystem

Abstracts away the file system.


Method Summary
 java.lang.String basename(java.lang.String path)
           
 java.lang.String canonicalPath(java.lang.String path)
           
 java.lang.String dirname(java.lang.String path)
           
 boolean exists(java.lang.String path)
           
 boolean isDirectory(java.lang.String path)
           
 boolean isFile(java.lang.String path)
           
 java.lang.String join(java.lang.String dir, java.lang.String path)
          Returns a path of the file path relative to dir.
 void mkdir(java.lang.String path)
           
 CharProducer read(java.lang.String path)
           
 InputSource toInputSource(java.lang.String path)
           
 java.io.Writer write(java.lang.String path)
           
 java.io.OutputStream writeBytes(java.lang.String path)
           
 

Method Detail

basename

java.lang.String basename(java.lang.String path)

canonicalPath

java.lang.String canonicalPath(java.lang.String path)
                               throws java.io.IOException
Throws:
java.io.IOException

dirname

java.lang.String dirname(java.lang.String path)

exists

boolean exists(java.lang.String path)

isFile

boolean isFile(java.lang.String path)

isDirectory

boolean isDirectory(java.lang.String path)

join

java.lang.String join(java.lang.String dir,
                      java.lang.String path)
Returns a path of the file path relative to dir.

Returns:
path if dir is the empty string. Otherwise the concatenation of the two paths with the appropriate separator in between.

read

CharProducer read(java.lang.String path)
                  throws java.io.IOException
Throws:
java.io.IOException

toInputSource

InputSource toInputSource(java.lang.String path)

mkdir

void mkdir(java.lang.String path)
           throws java.io.IOException
Throws:
java.io.IOException

writeBytes

java.io.OutputStream writeBytes(java.lang.String path)
                                throws java.io.IOException
Throws:
java.io.IOException

write

java.io.Writer write(java.lang.String path)
                     throws java.io.IOException
Throws:
java.io.IOException


Copyright (C) 2008 Google Inc.
Licensed under the Apache License, Version 2.0