IO (BaseX Core 9.5.2 API)

java.lang.Object
- org.basex.io.IO

Direct Known Subclasses:

IOContent, IOFile, IOStream, IOUrl
```
public abstract class IO
extends Object
```
Generic representation for inputs and outputs. The underlying source can be a local file (IOFile), a URL (IOUrl), a byte array (IOContent), or a stream (IOStream).

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASEXSUFFIX` Database file suffix.
`static int`	`BLOCKSIZE` Disk block/page size (4096).
`static String`	`BXSSUFFIX` Command script suffix.
`static String`	`CSVSUFFIX` CSV file suffix.
`static int`	`ENTRIES` Entries per block (256).
`static String`	`FILEPREF` File prefix.
`static String`	`GZSUFFIX` GZIP file suffix.
`static String[]`	`HTMLSUFFIXES` HTML suffixes.
`static String`	`IGNORESUFFIX` Ignore suffix.
`static String`	`JARSUFFIX` JAR file suffix.
`static String`	`JSONSUFFIX` JSON file suffix.
`static String[]`	`JSSUFFIXES` JS file suffixes.
`protected long`	`len` File size (in bytes).
`static String`	`LOGSUFFIX` XQuery log suffix.
`static int`	`MAXATTS` Maximum number of attributes (see bit layout in `Data` class).
`static int`	`NODEPOWER` Table node size power (4).
`static int`	`NODESIZE` Table node size power (16).
`protected String`	`pth` Absolute file path.
`static String`	`RAW` Directory for raw files.
`static String`	`TARGZSUFFIX` TGZIP file suffix.
`static String`	`TARSUFFIX` TAR file suffix.
`static String`	`TGZSUFFIX` TGZIP file suffix.
`static String`	`TMPSUFFIX` Temporary file suffix.
`static String[]`	`TXTSUFFIXES` Text suffixes.
`static String`	`XARSUFFIX` XAR file suffix.
`static String`	`XMLSUFFIX` XML file suffix.
`static String`	`XQMSUFFIX` XQuery module suffix.
`static String`	`XQSUFFIX` XQuery file suffix.
`static String[]`	`XQSUFFIXES` XQuery suffixes.
`static String[]`	`XSLSUFFIXES` XSL suffixes.
`static String`	`ZIPSUFFIX` ZIP file suffix.
`static String[]`	`ZIPSUFFIXES` Archive suffixes.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`checkSuffix(String path, String... suffixes)` Tests if the file suffix of a path matches the specified suffixes.
`String`	`dbName()` Generates a database name from the name of this resource.
`String`	`dir()` Returns the directory path (all characters up to the last slash).
`boolean`	`eq(IO io)` Compares the filename of the specified IO reference.
`boolean`	`exists()` Tests if the reference exists.
`static IO`	`get(String location)` Returns a class instance for the specified location string.
`boolean`	`hasSuffix(String... suffixes)` Tests if the file suffix matches the specified suffixes.
`abstract InputSource`	`inputSource()` Returns an input source.
`abstract InputStream`	`inputStream()` Returns an input stream.
`boolean`	`isAbsolute()` Tests if this is an absolute path.
`boolean`	`isArchive()` Checks if this file is an archive.
`boolean`	`isDir()` Tests if this is a local directory instance, or if the path ends with a slash.
`long`	`length()` Returns the file length.
`void`	`length(long length)` Sets the input length.
`IO`	`merge(String path)` Merges two paths.
`String`	`name()` Returns the name of the resource.
`void`	`name(String name)` Sets the name of the resource.
`String`	`path()` Returns the full path.
`abstract byte[]`	`read()` Returns the binary contents.
`abstract StreamSource`	`streamSource()` Returns a stream source.
`String`	`string()` Returns the contents as string.
`long`	`timeStamp()` Returns the time stamp (modification date) of this file.
`String`	`toString()`
`String`	`url()` Creates a URL from the specified path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TMPSUFFIX
```
public static final String TMPSUFFIX
```
    Temporary file suffix.
    
    See Also:
    
    Constant Field Values
  - BASEXSUFFIX
```
public static final String BASEXSUFFIX
```
    Database file suffix.
    
    See Also:
    
    Constant Field Values
  - BXSSUFFIX
```
public static final String BXSSUFFIX
```
    Command script suffix.
    
    See Also:
    
    Constant Field Values
  - XQSUFFIX
```
public static final String XQSUFFIX
```
    XQuery file suffix.
    
    See Also:
    
    Constant Field Values
  - XQMSUFFIX
```
public static final String XQMSUFFIX
```
    XQuery module suffix.
    
    See Also:
    
    Constant Field Values
  - XMLSUFFIX
```
public static final String XMLSUFFIX
```
    XML file suffix.
    
    See Also:
    
    Constant Field Values
  - ZIPSUFFIX
```
public static final String ZIPSUFFIX
```
    ZIP file suffix.
    
    See Also:
    
    Constant Field Values
  - CSVSUFFIX
```
public static final String CSVSUFFIX
```
    CSV file suffix.
    
    See Also:
    
    Constant Field Values
  - JSONSUFFIX
```
public static final String JSONSUFFIX
```
    JSON file suffix.
    
    See Also:
    
    Constant Field Values
  - JARSUFFIX
```
public static final String JARSUFFIX
```
    JAR file suffix.
    
    See Also:
    
    Constant Field Values
  - TARGZSUFFIX
```
public static final String TARGZSUFFIX
```
    TGZIP file suffix.
    
    See Also:
    
    Constant Field Values
  - TGZSUFFIX
```
public static final String TGZSUFFIX
```
    TGZIP file suffix.
    
    See Also:
    
    Constant Field Values
  - GZSUFFIX
```
public static final String GZSUFFIX
```
    GZIP file suffix.
    
    See Also:
    
    Constant Field Values
  - TARSUFFIX
```
public static final String TARSUFFIX
```
    TAR file suffix.
    
    See Also:
    
    Constant Field Values
  - XARSUFFIX
```
public static final String XARSUFFIX
```
    XAR file suffix.
    
    See Also:
    
    Constant Field Values
  - LOGSUFFIX
```
public static final String LOGSUFFIX
```
    XQuery log suffix.
    
    See Also:
    
    Constant Field Values
  - IGNORESUFFIX
```
public static final String IGNORESUFFIX
```
    Ignore suffix.
    
    See Also:
    
    Constant Field Values
  - RAW
```
public static final String RAW
```
    Directory for raw files.
    
    See Also:
    
    Constant Field Values
  - FILEPREF
```
public static final String FILEPREF
```
    File prefix.
    
    See Also:
    
    Constant Field Values
  - XQSUFFIXES
```
public static final String[] XQSUFFIXES
```
    XQuery suffixes.
  - ZIPSUFFIXES
```
public static final String[] ZIPSUFFIXES
```
    Archive suffixes.
  - XSLSUFFIXES
```
public static final String[] XSLSUFFIXES
```
    XSL suffixes.
  - HTMLSUFFIXES
```
public static final String[] HTMLSUFFIXES
```
    HTML suffixes.
  - TXTSUFFIXES
```
public static final String[] TXTSUFFIXES
```
    Text suffixes.
  - JSSUFFIXES
```
public static final String[] JSSUFFIXES
```
    JS file suffixes.
  - BLOCKSIZE
```
public static final int BLOCKSIZE
```
    Disk block/page size (4096).
    
    See Also:
    
    Constant Field Values
  - NODEPOWER
```
public static final int NODEPOWER
```
    Table node size power (4).
    
    See Also:
    
    Constant Field Values
  - NODESIZE
```
public static final int NODESIZE
```
    Table node size power (16).
    
    See Also:
    
    Constant Field Values
  - ENTRIES
```
public static final int ENTRIES
```
    Entries per block (256).
    
    See Also:
    
    Constant Field Values
  - MAXATTS
```
public static final int MAXATTS
```
    Maximum number of attributes (see bit layout in Data class).
    
    See Also:
    
    Constant Field Values
  - pth
```
protected String pth
```
    Absolute file path. All paths have forward slashes, no matter which OS is used.
  - len
```
protected long len
```
    File size (in bytes).
- Method Detail
  - get
```
public static IO get(String location)
```
    Returns a class instance for the specified location string. The type of the returned instance depends on the string value:
    - IOFile: if the string starts with file:, or if it does not contain the substring ://, it is interpreted as local file instance
    - IOUrl: if it starts with a valid scheme, it is handled as URL
    - IOContent: otherwise, it is interpreted as XML fragment and internally represented as byte array
    If the content of the string value is known in advance, it is advisable to call the direct constructors of the correspondent sub class.
    Parameters:
    
    location - location
    
    Returns:
    
    IO reference
  - read
```
public abstract byte[] read()
                     throws IOException
```
    Returns the binary contents.
    
    Returns:
    
    binary contents
    
    Throws:
    
    IOException - I/O exception
  - string
```
public final String string()
                    throws IOException
```
    Returns the contents as string. The input encoding will be guessed by analyzing the first bytes. UTF-8 will be used as fallback.
    
    Returns:
    
    string contents
    
    Throws:
    
    IOException - I/O exception
  - exists
```
public boolean exists()
```
    Tests if the reference exists. Returns true for IO instances other than IOFile.
    
    Returns:
    
    result of check
  - isDir
```
public boolean isDir()
```
    Tests if this is a local directory instance, or if the path ends with a slash.
    
    Returns:
    
    result of check
  - isAbsolute
```
public boolean isAbsolute()
```
    Tests if this is an absolute path.
    
    Returns:
    
    result of check
  - hasSuffix
```
public final boolean hasSuffix(String... suffixes)
```
    Tests if the file suffix matches the specified suffixes.
    
    Parameters:
    
    suffixes - suffixes to compare with
    
    Returns:
    
    result of check
  - timeStamp
```
public long timeStamp()
```
    Returns the time stamp (modification date) of this file. Returns the current time for IO instances other than IOFile.
    
    Returns:
    
    time stamp
  - length
```
public final void length(long length)
```
    Sets the input length.
    
    Parameters:
    
    length - length
  - length
```
public long length()
```
    Returns the file length.
    
    Returns:
    
    file length
  - inputSource
```
public abstract InputSource inputSource()
```
    Returns an input source.
    
    Returns:
    
    input source
  - streamSource
```
public abstract StreamSource streamSource()
```
    Returns a stream source.
    
    Returns:
    
    stream source
  - inputStream
```
public abstract InputStream inputStream()
                                 throws IOException
```
    Returns an input stream.
    
    Returns:
    
    input stream
    
    Throws:
    
    IOException - I/O exception
  - merge
```
public final IO merge(String path)
```
    Merges two paths.
    
    Parameters:
    
    path - path to be merged
    
    Returns:
    
    resulting reference
  - isArchive
```
public final boolean isArchive()
```
    Checks if this file is an archive.
    
    Returns:
    
    result of check
  - dbName
```
public final String dbName()
```
    Generates a database name from the name of this resource. The path will be chopped and special characters from the remaining name will be removed.
    
    Returns:
    
    database name
  - name
```
public final String name()
```
    Returns the name of the resource.
    
    Returns:
    
    file name
  - name
```
public final void name(String name)
```
    Sets the name of the resource.
    
    Parameters:
    
    name - file name
  - path
```
public final String path()
```
    Returns the full path. The path uses forward slashes, no matter which OS is used.
    
    Returns:
    
    path
  - dir
```
public final String dir()
```
    Returns the directory path (all characters up to the last slash). No check will be performed if the directory exists.
    
    Returns:
    
    directory path
  - url
```
public String url()
```
    Creates a URL from the specified path. Returns the original path for IO instances other than IOFile.
    
    Returns:
    
    URL
  - eq
```
public boolean eq(IO io)
```
    Compares the filename of the specified IO reference.
    
    Parameters:
    
    io - io reference
    
    Returns:
    
    result of check
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - checkSuffix
```
public static boolean checkSuffix(String path,
                                  String... suffixes)
```
    Tests if the file suffix of a path matches the specified suffixes.
    
    Parameters:
    
    path - path
    
    suffixes - suffixes to compare with
    
    Returns:
    
    result of check

Class IO

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TMPSUFFIX

BASEXSUFFIX

BXSSUFFIX

XQSUFFIX

XQMSUFFIX

XMLSUFFIX

ZIPSUFFIX

CSVSUFFIX

JSONSUFFIX

JARSUFFIX

TARGZSUFFIX

TGZSUFFIX

GZSUFFIX

TARSUFFIX

XARSUFFIX

LOGSUFFIX

IGNORESUFFIX

RAW

FILEPREF

XQSUFFIXES

ZIPSUFFIXES

XSLSUFFIXES

HTMLSUFFIXES

TXTSUFFIXES

JSSUFFIXES

BLOCKSIZE

NODEPOWER

NODESIZE

ENTRIES

MAXATTS

pth

len

Method Detail

get

read

string

exists

isDir

isAbsolute

hasSuffix

timeStamp

length

length

inputSource

streamSource

inputStream

merge

isArchive

dbName

name

name

path

dir

url

eq

toString

checkSuffix