org.basex.io

Class IOFile

java.lang.Object

org.basex.io.IO

org.basex.io.IOFile

public final class IOFile
extends IO

IO reference, representing a local file or directory path.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.io.IO

BASEXSUFFIX, BLOCKSIZE, CSVSUFFIX, DATE, DATEPATTERN, ENTRIES, FILEPREF, GZSUFFIX, HTMLSUFFIXES, JSONSUFFIX, MAXATTS, NODEPOWER, NODESIZE, OFFCOMP, OFFNUM, TXTSUFFIXES, XARSUFFIX, XMLSUFFIX, XMLSUFFIXES, XQMSUFFIX, XQSUFFIX, XQSUFFIXES, ZIPSUFFIX, ZIPSUFFIXES

Constructor Summary

Constructors

Constructor and Description
IOFile(java.io.File f) Constructor.
IOFile(IOFile dir, java.lang.String n) Constructor.
IOFile(java.lang.String f) Constructor.
IOFile(java.lang.String dir, java.lang.String n) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
IOFile[]	children() Returns the children of the path.
IOFile[]	children(java.lang.String pattern) Returns the children of the path that match the specified regular expression.
boolean	delete() Deletes the IO reference.
StringList	descendants() Returns the relative paths of all descendant files.
java.lang.String	dir() Returns the directory.
boolean	exists() Tests if the file exists.
java.io.File	file() Returns the file reference.
org.xml.sax.InputSource	inputSource() Returns an input source.
java.io.InputStream	inputStream() Returns an input stream.
boolean	isArchive() Checks if this file is an archive.
boolean	isDir() Tests if this is a directory instance.
boolean	isXML() Checks if this file contains XML.
long	length() Returns the file length.
boolean	md() Recursively creates the directory.
IO	merge(java.lang.String f) Merges two filenames.
boolean	more(boolean archives) Checks if more input streams are found.
byte[]	read() Returns the contents.
static java.lang.String	regex(java.lang.String glob) Converts a file filter (glob) to a regular expression.
static java.lang.String	regex(java.lang.String glob, boolean sub) Converts a file filter (glob) to a regular expression.
boolean	rename(IOFile trg) Renames the file to the specified name.
long	timeStamp() Returns the modification date of this file.
boolean	touch() Creates a new instance of this file.
java.lang.String	url() Creates a URL from the specified path.
void	write(byte[] c) Writes the specified byte array.
void	write(java.io.InputStream in) Writes the specified input.

Methods inherited from class org.basex.io.IO

dbname, eq, get, name, name, path, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IOFile

public IOFile(java.lang.String f)

Constructor.

Parameters:

f - file path

IOFile

public IOFile(java.io.File f)

Constructor.

Parameters:

f - file reference

IOFile

public IOFile(java.lang.String dir,
      java.lang.String n)

Constructor.

Parameters:

dir - directory

n - file name

IOFile

public IOFile(IOFile dir,
      java.lang.String n)

Constructor.

Parameters:

dir - directory

n - file name

Method Detail

file

public java.io.File file()

Returns the file reference.

Returns:

file reference

touch

public boolean touch()

Creates a new instance of this file.

Returns:

success flag

read

public byte[] read()
            throws java.io.IOException

Description copied from class: IO

Returns the contents.

Specified by:

read in class IO

Returns:

contents

Throws:

java.io.IOException - I/O exception

exists

public boolean exists()

Description copied from class: IO

Tests if the file exists. Returns true by default.

Overrides:

exists in class IO

Returns:

result of check

isDir

public boolean isDir()

Description copied from class: IO

Tests if this is a directory instance.

Overrides:

isDir in class IO

Returns:

result of check

timeStamp

public long timeStamp()

Description copied from class: IO

Returns the modification date of this file.

Overrides:

timeStamp in class IO

Returns:

modification date

length

public long length()

Description copied from class: IO

Returns the file length.

Specified by:

length in class IO

Returns:

file length

more

public boolean more(boolean archives)
             throws java.io.IOException

Description copied from class: IO

Checks if more input streams are found.

Overrides:

more in class IO

Parameters:

archives - parse archives

Returns:

result of check

Throws:

java.io.IOException - I/O exception

isArchive

public boolean isArchive()

Description copied from class: IO

Checks if this file is an archive.

Overrides:

isArchive in class IO

Returns:

result of check

isXML

public boolean isXML()

Description copied from class: IO

Checks if this file contains XML.

Overrides:

isXML in class IO

Returns:

result of check

inputSource

public org.xml.sax.InputSource inputSource()

Description copied from class: IO

Returns an input source.

Specified by:

inputSource in class IO

Returns:

input source

inputStream

public java.io.InputStream inputStream()
                                throws java.io.IOException

Description copied from class: IO

Returns an input stream.

Specified by:

inputStream in class IO

Returns:

input stream

Throws:

java.io.IOException - I/O exception

merge

public IO merge(java.lang.String f)

Description copied from class: IO

Merges two filenames.

Specified by:

merge in class IO

Parameters:

f - file name/path to be appended

Returns:

resulting reference

md

public boolean md()

Recursively creates the directory.

Returns:

contents

dir

public java.lang.String dir()

Description copied from class: IO

Returns the directory.

Overrides:

dir in class IO

Returns:

chopped filename

children

public IOFile[] children()

Returns the children of the path.

Returns:

children

children

public IOFile[] children(java.lang.String pattern)

Returns the children of the path that match the specified regular expression.

Parameters:

pattern - regular expression pattern

Returns:

children

descendants

public StringList descendants()

Returns the relative paths of all descendant files.

Returns:

relative paths

write

public void write(byte[] c)
           throws java.io.IOException

Writes the specified byte array.

Parameters:

c - contents

Throws:

java.io.IOException - I/O exception

write

public void write(java.io.InputStream in)
           throws java.io.IOException

Writes the specified input.

Parameters:

in - input stream

Throws:

java.io.IOException - I/O exception

delete

public boolean delete()

Deletes the IO reference.

Returns:

success flag

rename

public boolean rename(IOFile trg)

Renames the file to the specified name.

Parameters:

trg - target reference

Returns:

success flag

url

public java.lang.String url()

Description copied from class: IO

Creates a URL from the specified path.

Overrides:

url in class IO

Returns:

URL

regex

public static java.lang.String regex(java.lang.String glob)

Converts a file filter (glob) to a regular expression.

Parameters:

glob - filter

Returns:

regular expression

regex

public static java.lang.String regex(java.lang.String glob,
                     boolean sub)

Converts a file filter (glob) to a regular expression. A filter may contain asterisks (*) and question marks (?); commas (,) are used to separate multiple filters.

Parameters:

glob - filter

sub - accept substring in the result

Returns:

regular expression