PhantomFile (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.PhantomFile

All Implemented Interfaces:

NetPhantomConstants
```
public class PhantomFile
extends Object
implements NetPhantomConstants
```
This class is used for opening and reading files that are stored using Phantom Hurricane in OEM ASCII or Ansi character set.
New functions to create a buffered FileReader and FileWriter using different encodings is now also available. See the methods createFileReader and createFileWriter.

Author:

Christopher Mindus

Field Summary

Fields
Modifier and Type Field and Description

static String[] dayNames
The month names.

static String[] monthNames
The month names.
- Fields inherited from interface se.entra.phantom.common.NetPhantomConstants
  ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_COPYRIGHT, NETPHANTOM_COPYRIGHT2, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_HWND, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Fields
Modifier and Type	Field and Description
`static String[]`	`dayNames` The month names.
`static String[]`	`monthNames` The month names.

Constructor Summary

Constructors
Constructor and Description
`PhantomFile(byte[] data)` Creates a new instance of a file in memory.
`PhantomFile(byte[] data, PhantomFile openFile)` Creates a new instance of a file in memory.
`PhantomFile(byte[] data, String fileName)` Creates a new instance of a file in memory.
`PhantomFile(File file)` Creates a new instance of a file from an input stream, typically from ZIP/JAR files.
`PhantomFile(InputStream in)` Creates a new instance of a file from an input stream, typically from ZIP/JAR files.
`PhantomFile(InputStream in, String fileName)` Creates a new instance of a file from an input stream, typically from ZIP/JAR files.
`PhantomFile(PhantomFile file, int position)` Opens a new instance of a file at a specified file position.
`PhantomFile(String fileName)` Opens the specified file for read.
`PhantomFile(String fileName, boolean doSearchPath)` Opens the specified file for read.
`PhantomFile(String fileName, PhantomFile openFile)` Opens the specified file for read.
`PhantomFile(String fileName, String previousFile)` Opens the specified file for read.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close stream and file.
`static boolean`	`deleteFileAndChildren(File dir)` Deletes a file or directory along with all its children (in case of a directory).
`static String`	`findFileInDirectory(File dir, String fileName, boolean matchCase)` Finds a file in a directory or in one of it's sub-directories.
`static String`	`findFileInDirectory(String dir, String fileName, boolean matchCase)` Finds a file in a directory or in one of it's sub-directories.
`static String`	`findFileInPath(String fileName)` Locates the specified file.
`static String`	`findFileInPath(String fileName, boolean doSearchPath)` Locates the specified file.
`static int`	`findFilesInDirectory(File dir, ArrayList<String> fileNames, boolean matchCase, VirtualControl dirDisplay)` Finds a file in a directory or in one of it's sub-directories.
`static int`	`findFilesInDirectory(String dir, ArrayList<String> fileNames, boolean matchCase, VirtualControl dirDisplay)` Finds a file in a directory or in one of it's sub-directories.
`static String`	`getBaseName(String fn)` Gets the base file name without path and file extension.
`static File`	`getCanonicalFile(File f)` Gets the canonical file if possible, if it fails with IOException the absolute path is returned.
`static File`	`getCanonicalFile(String filePath)` Gets the canonical file if possible, if it fails with IOException the absolute path is returned.
`static String`	`getCanonicalPath(File f)` Gets the canonical file path if possible, if it fails with IOException the absolute path is returned.
`static String`	`getCanonicalPath(String filePath)` Gets the canonical file path if possible, if it fails with IOException the absolute path is returned.
`static String`	`getFileExtension(File file)` Gets the extension of a file.
`static String`	`getFileExtension(String fileName)` Gets the extension of a file.
`String`	`getFileName()` Gets the file name.
`String`	`getFileNameFromAnother(String base)` Returns a file name and path that is taken from the current PhantomFile instance with path, but with the base name of the file name in PhantomFile.
`static String`	`getFileNameFromAnother(String base, String another)` Returns a file name and path that is taken from a file with path, but with the base name of another file.
`String`	`getFileTimestamp()` Get file time stamp as DayName Month day HH:MM:SS year.
`static String`	`getFileTimestamp(long lastModified)` Get file time stamp as DayName Month day HH:MM:SS year.
`static String`	`getFileTimestamp(String fileName)` Get file time stamp as DayName Month day HH:MM:SS year.
`byte`	`getMemoryDataByte()` Gets the current byte from the memory data (same as readByte but without advancing the position).
`static String`	`getRelativeFileName(String fileName, String reference)` Gets the relative file name from another file (if possible).
`static String`	`getRelativeFileName(String fileName, String reference, boolean canonicalIfAbove)` Gets the relative file name from another file (if possible).
`static String`	`getRelativeFileName(String fileName, String reference, boolean mustBeChildOrSibling, boolean stripRelativePath, boolean mustExist, boolean mustBeFile)` Gets a file name relative to a reference file name.
`static String`	`getRelativePath(File home, File f)` Get relative path of File 'f' with respect to 'home' directory.
`static String`	`getRelativePath(File home, File f, boolean canonicalIfAbove)` Get relative path of File 'f' with respect to 'home' directory.
`int`	`getRemainingSize()` Gets the remaining size in the memory file.
`static boolean`	`hasFileExtension(File file, boolean caseSensitive, String... extensions)` Checks the extension of a file for a valid one with the ones specified in the list of extensions.
`static boolean`	`hasFileExtension(String fileName, boolean caseSensitive, String... extensions)` Checks the extension of a file for a valid one with the ones specified in the list of extensions.
`static boolean`	`isJarOrZipFile(File file)` Checks if a file is of Jar or Zip file type (i.e.
`static boolean`	`isJarOrZipFile(String fileName)` Checks if a file is of Jar or Zip file type (i.e.
`static boolean`	`isSameFile(File f1, File f2)` Checks if two file names refer to the same file, i.e.
`static boolean`	`isSameFile(String fn1, String fn2)` Checks if two file names refer to the same file, i.e.
`long`	`lastModified()` Returns the time that the file represented by this file object was last modified.
`static boolean`	`listDirectory(File dir, ArrayList<File> array)` Gets a directory listing including all children and sub-directories.
`static boolean`	`listDirectory(String dir, ArrayList<File> array)` Gets a directory listing including all children and sub-directories.
`static byte[]`	`loadFile(File file)` Loads a file into memory.
`static byte[]`	`loadFile(InputStream in)` Loads a file into memory.
`static byte[]`	`loadFile(JarFile jar, JarEntry je)` Loads a file into memory.
`static byte[]`	`loadFile(PhantomFile file)` Loads a file into memory.
`static byte[]`	`loadFile(String fileName)` Loads a file into memory.
`byte[]`	`read(int size)` Reads a number of bytes from the file.
`String`	`readAnsiLine()` Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file.
`Vector<String>`	`readBOMStringVector(boolean skipEmptyLines, boolean trimLeading, boolean trimTrailing, String encoding)` Reads the file until end as a string vector.
`boolean`	`readBoolean()` Reads a boolean byte value from file.
`int`	`readByte()` Reads an unsigned byte value from the file.
`byte[]`	`readByteLine()` Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file.
`double`	`readIntelDouble()` Reads a double value from the file.
`int`	`readIntelLong()` Reads a signed long value from the file in Intel style.
`int`	`readIntelShort()` Reads an signed short value from the file in Intel style.
`int`	`readIntelUShort()` Reads an unsigned short value from the file in Intel style.
`String`	`readISOLine()` Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file.
`String`	`readOEMBytes(int size)` Reads a number of OEM bytes and returns it as a string.
`String`	`readOEMLine()` Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file.
`String`	`readOEMString()` Reads a number of OEM bytes and returns it as a string.
`String`	`readOEMString(int size)` Reads a number of OEM bytes and returns it as a string.
`Vector<String>`	`readOEMStringVector(boolean skipEmptyLines)` Reads the file until end as a string vector.
`Vector<String>`	`readOEMStringVector(boolean skipEmptyLines, boolean trimLines)` Reads the file until end as a string vector.
`Vector<String>`	`readOEMStringVector(boolean skipEmptyLines, boolean trimLeading, boolean trimTrailing)` Reads the file until end as a string vector.
`String`	`readString()` Reads a number of bytes and returns it as a string.
`String`	`readString(int size)` Reads a number of bytes and returns it as a string.
`String`	`readUnicodeChars(int size)` Reads a number of Unicode characters (16-bit words) and returns it as a string.
`String`	`readUnicodeString(int size)` Reads a number of Unicode characters (16-bit words) and returns it as a string.
`void`	`skipBytes(int n)` Skips a number of bytes.

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

- Field Detail
  - monthNames
```
public static final String[] monthNames
```
    The month names.
  - dayNames
```
public static final String[] dayNames
```
    The month names.
- Constructor Detail
  - PhantomFile
```
public PhantomFile(String fileName)
            throws IOException
```
    Opens the specified file for read.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomFile
```
public PhantomFile(String fileName,
                   boolean doSearchPath)
            throws IOException
```
    Opens the specified file for read. The file can be located in the Java Class Path, but not in any archives (zip/jar). If the file name contains a relative or absolute path, the path will not be searched.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomFile
```
public PhantomFile(String fileName,
                   PhantomFile openFile)
            throws IOException
```
    Opens the specified file for read. The directory of the file name is taken from the instance of the PhantomFile passed into this method.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomFile
```
public PhantomFile(String fileName,
                   String previousFile)
            throws IOException
```
    Opens the specified file for read. The directory of the file name is taken from the file name passed into this method.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomFile
```
public PhantomFile(PhantomFile file,
                   int position)
            throws IOException
```
    Opens a new instance of a file at a specified file position.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomFile
```
public PhantomFile(byte[] data)
```
    Creates a new instance of a file in memory.
  - PhantomFile
```
public PhantomFile(byte[] data,
                   String fileName)
```
    Creates a new instance of a file in memory.
  - PhantomFile
```
public PhantomFile(byte[] data,
                   PhantomFile openFile)
```
    Creates a new instance of a file in memory. The file name is taken from the current open file.
  - PhantomFile
```
public PhantomFile(InputStream in)
```
    Creates a new instance of a file from an input stream, typically from ZIP/JAR files.
  - PhantomFile
```
public PhantomFile(InputStream in,
                   String fileName)
```
    Creates a new instance of a file from an input stream, typically from ZIP/JAR files.
  - PhantomFile
```
public PhantomFile(File file)
            throws FileNotFoundException
```
    Creates a new instance of a file from an input stream, typically from ZIP/JAR files.
    
    Throws:
    
    FileNotFoundException - if file is not found.
- Method Detail
  - loadFile
```
public static byte[] loadFile(InputStream in)
                       throws IOException
```
    Loads a file into memory.
    
    Parameters:
    
    in - the input stream.
    
    Returns:
    
    null for out of memory.
    
    Throws:
    
    FileNotFoundException - if the file cannot be found.
    
    IOException - if the file cannot be loaded.
  - loadFile
```
public static byte[] loadFile(PhantomFile file)
                       throws IOException
```
    Loads a file into memory.
    
    Returns:
    
    null for out of memory.
    
    Throws:
    
    FileNotFoundException - if the file cannot be found.
    
    IOException - if the file cannot be loaded.
  - loadFile
```
public static byte[] loadFile(String fileName)
                       throws IOException
```
    Loads a file into memory.
    
    Returns:
    
    null for out of memory.
    
    Throws:
    
    FileNotFoundException - if the file cannot be found.
    
    IOException - if the file cannot be loaded.
  - loadFile
```
public static byte[] loadFile(File file)
                       throws IOException
```
    Loads a file into memory.
    
    Returns:
    
    null for out of memory.
    
    Throws:
    
    FileNotFoundException - if the file cannot be found.
    
    IOException - if the file cannot be loaded.
  - loadFile
```
public static byte[] loadFile(JarFile jar,
                              JarEntry je)
                       throws IOException
```
    Loads a file into memory.
    
    Returns:
    
    null for out of memory.
    
    Throws:
    
    FileNotFoundException - if the file cannot be found.
    
    IOException - if the file cannot be loaded.
  - close
```
public void close()
```
    Close stream and file.
  - getFileNameFromAnother
```
public static String getFileNameFromAnother(String base,
                                            String another)
```
    Returns a file name and path that is taken from a file with path, but with the base name of another file. If the new base file name starts with a file name separator as "/path/filename", and is therefore not relative as "./path/filename" or "path/filename", the path of the other file is not used. This is also valid for drive specification such as "c:\path\filename" or "unit:/path/filename".
  - getFileNameFromAnother
```
public String getFileNameFromAnother(String base)
```
    Returns a file name and path that is taken from the current PhantomFile instance with path, but with the base name of the file name in PhantomFile.
  - read
```
public byte[] read(int size)
            throws IOException
```
    Reads a number of bytes from the file.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readString
```
public String readString()
                  throws IOException
```
    Reads a number of bytes and returns it as a string. The string ends if a zero-termination character is encountered. The string is assumed to be in default Ansi code page.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    readOEMString()
  - readString
```
public String readString(int size)
                  throws IOException
```
    Reads a number of bytes and returns it as a string. The string ends if a zero-termination character is encountered. The string is assumed to be in default Ansi code page. Note: The entire string is read from the file as specified by the size.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    readOEMString()
  - readOEMString
```
public String readOEMString()
                     throws IOException
```
    Reads a number of OEM bytes and returns it as a string. The string ends if a zero-termination character is encountered. Note: conversion is done from the current code page to Unicode.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    readString(), readOEMBytes(int)
  - readOEMString
```
public String readOEMString(int size)
                     throws IOException
```
    Reads a number of OEM bytes and returns it as a string. The string ends if a zero-termination character is encountered. Note: conversion is done from the current code page to Unicode. Note: The entire string is read from the file as specified by the size.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    readString(), readOEMBytes(int)
  - readUnicodeString
```
public String readUnicodeString(int size)
                         throws IOException
```
    Reads a number of Unicode characters (16-bit words) and returns it as a string. The string ends as soon as a zero-character is read.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    read(int), readOEMString()
  - readOEMBytes
```
public String readOEMBytes(int size)
                    throws IOException
```
    Reads a number of OEM bytes and returns it as a string. Note: conversion is done from the current code page to Unicode.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    read(int), readOEMString()
  - readUnicodeChars
```
public String readUnicodeChars(int size)
                        throws IOException
```
    Reads a number of Unicode characters (16-bit words) and returns it as a string. The string ends as soon as a zero-character is read.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    read(int), readOEMString()
  - readByte
```
public int readByte()
             throws IOException
```
    Reads an unsigned byte value from the file.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readBoolean
```
public boolean readBoolean()
                    throws IOException
```
    Reads a boolean byte value from file.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readIntelUShort
```
public int readIntelUShort()
                    throws IOException
```
    Reads an unsigned short value from the file in Intel style.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readIntelShort
```
public int readIntelShort()
                   throws IOException
```
    Reads an signed short value from the file in Intel style.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readIntelLong
```
public int readIntelLong()
                  throws IOException
```
    Reads a signed long value from the file in Intel style.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readIntelDouble
```
public double readIntelDouble()
                       throws IOException
```
    Reads a double value from the file.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - skipBytes
```
public void skipBytes(int n)
               throws IOException
```
    Skips a number of bytes.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getRemainingSize
```
public int getRemainingSize()
```
    Gets the remaining size in the memory file. It returns an estimate of what is "available()" when an input stream is used.
  - getFileName
```
public String getFileName()
```
    Gets the file name. This method may return null if the instance of this object is created from a byte array.
  - readOEMStringVector
```
public Vector<String> readOEMStringVector(boolean skipEmptyLines)
                                   throws IOException
```
    Reads the file until end as a string vector.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readOEMStringVector
```
public Vector<String> readOEMStringVector(boolean skipEmptyLines,
                                          boolean trimLines)
                                   throws IOException
```
    Reads the file until end as a string vector.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readOEMStringVector
```
public Vector<String> readOEMStringVector(boolean skipEmptyLines,
                                          boolean trimLeading,
                                          boolean trimTrailing)
                                   throws IOException
```
    Reads the file until end as a string vector.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readBOMStringVector
```
public Vector<String> readBOMStringVector(boolean skipEmptyLines,
                                          boolean trimLeading,
                                          boolean trimTrailing,
                                          String encoding)
                                   throws IOException
```
    Reads the file until end as a string vector. File can begin with a BOM and has the default encoding.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readByteLine
```
public byte[] readByteLine()
                    throws IOException
```
    Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file.
    
    Returns:
    
    null for end of file.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    PhantomOutputFile.writeLine(byte[])
  - readOEMLine
```
public String readOEMLine()
                   throws IOException
```
    Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file.
    
    Returns:
    
    null for end of file.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readAnsiLine
```
public String readAnsiLine()
                    throws IOException
```
    Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file.
    
    Returns:
    
    null for end of file.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readISOLine
```
public String readISOLine()
                   throws IOException
```
    Reads a line in the file up to the next new line (CR/LF or just LF) or the end of the file. The data in the file should be encoded in ISO 8859-1.
    Typically, this function is used to read data that have been written with PhantomOutputFile.writeISOLine.
    
    Returns:
    
    null for end of file.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    See Also:
    
    PhantomOutputFile.writeISOLine(java.lang.String)
  - getMemoryDataByte
```
public byte getMemoryDataByte()
```
    Gets the current byte from the memory data (same as readByte but without advancing the position).
  - findFileInPath
```
public static String findFileInPath(String fileName)
```
    Locates the specified file. The file can be located in the Java Class Path, but not in any archives (zip/jar). If the file name contains a relative or absolute path, the path will not be searched.
    
    Returns:
    
    null if the file is not found.
  - findFileInPath
```
public static String findFileInPath(String fileName,
                                    boolean doSearchPath)
```
    Locates the specified file. The file can be located in the Java Class Path, but not in any archives (zip/jar). If the file name contains a relative or absolute path, the path will not be searched.
    
    Returns:
    
    null if the file is not found.
  - findFileInDirectory
```
public static String findFileInDirectory(String dir,
                                         String fileName,
                                         boolean matchCase)
```
    Finds a file in a directory or in one of it's sub-directories. This function performs variable substitution such as "%ProgramFiles%\firefox.exe" to search for the FireFox executable in the program files folder defined for the computer in the environment.
    
    Returns:
    
    the full path to the file, or null if not found or for errors in the variable substitution.
  - findFileInDirectory
```
public static String findFileInDirectory(File dir,
                                         String fileName,
                                         boolean matchCase)
```
    Finds a file in a directory or in one of it's sub-directories.
    
    Returns:
    
    the full path to the file, or null if not found.
  - findFilesInDirectory
```
public static int findFilesInDirectory(String dir,
                                       ArrayList<String> fileNames,
                                       boolean matchCase,
                                       VirtualControl dirDisplay)
```
    Finds a file in a directory or in one of it's sub-directories. This function performs variable substitution such as "%ProgramFiles%\firefox.exe" to search for the FireFox executable in the program files folder defined for the computer in the environment. The parameter "dirDisplay" can be null.
    
    Returns:
    
    The count of files found, the original list is modified.
  - findFilesInDirectory
```
public static int findFilesInDirectory(File dir,
                                       ArrayList<String> fileNames,
                                       boolean matchCase,
                                       VirtualControl dirDisplay)
```
    Finds a file in a directory or in one of it's sub-directories. The parameter "dirDisplay" can be null.
    
    Returns:
    
    the count of files found.
  - lastModified
```
public long lastModified()
```
    Returns the time that the file represented by this file object was last modified. The return value is system dependent and should only be used to compare with other values returned by last modified. It should not be interpreted as an absolute time.
    
    Returns:
    
    the time the file specified by this object was last modified, or 0L if the specified file does not exist.
  - getFileTimestamp
```
public static String getFileTimestamp(String fileName)
```
    Get file time stamp as DayName Month day HH:MM:SS year.
  - getFileTimestamp
```
public String getFileTimestamp()
```
    Get file time stamp as DayName Month day HH:MM:SS year.
  - getFileTimestamp
```
public static String getFileTimestamp(long lastModified)
```
    Get file time stamp as DayName Month day HH:MM:SS year.
  - getBaseName
```
public static String getBaseName(String fn)
```
    Gets the base file name without path and file extension. This is typically used for the package name for Java code. The case of the base name is unchanged.
  - isSameFile
```
public static boolean isSameFile(String fn1,
                                 String fn2)
```
    Checks if two file names refer to the same file, i.e. has the same canonical file names.
  - isSameFile
```
public static boolean isSameFile(File f1,
                                 File f2)
```
    Checks if two file names refer to the same file, i.e. has the same canonical file names.
  - getCanonicalPath
```
public static String getCanonicalPath(File f)
```
    Gets the canonical file path if possible, if it fails with IOException the absolute path is returned.
  - getCanonicalFile
```
public static File getCanonicalFile(File f)
```
    Gets the canonical file if possible, if it fails with IOException the absolute path is returned.
  - getCanonicalPath
```
public static String getCanonicalPath(String filePath)
```
    Gets the canonical file path if possible, if it fails with IOException the absolute path is returned.
  - getCanonicalFile
```
public static File getCanonicalFile(String filePath)
```
    Gets the canonical file if possible, if it fails with IOException the absolute path is returned.
  - getRelativeFileName
```
public static String getRelativeFileName(String fileName,
                                         String reference,
                                         boolean mustBeChildOrSibling,
                                         boolean stripRelativePath,
                                         boolean mustExist,
                                         boolean mustBeFile)
                                  throws IOException,
                                         FileNotFoundException
```
    Gets a file name relative to a reference file name. The flag "mustBeChildOrSibling" is used to check that the file name is relative the reference, but is not "above" it. The files must exist.
    
    Returns:
    
    null for failure.
    
    Throws:
    
    IOException
    
    FileNotFoundException
  - getRelativePath
```
public static String getRelativePath(File home,
                                     File f,
                                     boolean canonicalIfAbove)
                              throws IOException
```
    Get relative path of File 'f' with respect to 'home' directory.
```
 example : home = /a/b/c
           f    = /a/d/e/x.txt
           s = getRelativePath(home,f) = ../../d/e/x.txt
 
```
    Parameters:
    
    home - base path, should be a directory, not a file, or it doesn't make sense.
    
    f - file to generate path for.
    
    Returns:
    
    path from home to f as a string
    
    Throws:
    
    IOException - for file failures.
  - getRelativePath
```
public static String getRelativePath(File home,
                                     File f)
                              throws IOException
```
    Get relative path of File 'f' with respect to 'home' directory.
```
 example : home = /a/b/c
           f    = /a/d/e/x.txt
           s = getRelativePath(home,f) = ../../d/e/x.txt
 
```
    Parameters:
    
    home - base path, should be a directory, not a file, or it doesn't make sense.
    
    f - file to generate path for.
    
    Returns:
    
    path from home to f as a string
    
    Throws:
    
    IOException - for file failures.
  - getRelativeFileName
```
public static String getRelativeFileName(String fileName,
                                         String reference)
```
    Gets the relative file name from another file (if possible). The parameter "reference" can be seen as the "home" file or directory to make the other file ("filename") relative to.
  - getRelativeFileName
```
public static String getRelativeFileName(String fileName,
                                         String reference,
                                         boolean canonicalIfAbove)
```
    Gets the relative file name from another file (if possible). The parameter "reference" can be seen as the "home" file or directory to make the other file ("filename") relative to.
  - listDirectory
```
public static boolean listDirectory(String dir,
                                    ArrayList<File> array)
```
    Gets a directory listing including all children and sub-directories.
    
    Returns:
    
    true for success, false for failure.
  - listDirectory
```
public static boolean listDirectory(File dir,
                                    ArrayList<File> array)
```
    Gets a directory listing including all children and sub-directories.
    
    Returns:
    
    true for success, false for failure.
  - deleteFileAndChildren
```
public static boolean deleteFileAndChildren(File dir)
```
    Deletes a file or directory along with all its children (in case of a directory).
    
    Returns:
    
    true for success, false for failure (some file/directory may remain, but as much as possible is deleted).
  - getFileExtension
```
public static String getFileExtension(File file)
```
    Gets the extension of a file. The return value is the extension of the file without the last dot. This functions doesn't make a difference with the OS implementations "\" or "/", both are accepted!
    
    Parameters:
    
    file - the file.
    
    Returns:
    
    null when no file extension is found!
  - getFileExtension
```
public static String getFileExtension(String fileName)
```
    Gets the extension of a file. The return value is the extension of the file without the last dot. This functions doesn't make a difference with the OS implementations "\" or "/", both are accepted!
    
    Parameters:
    
    fileName - the file name.
    
    Returns:
    
    null when no file extension is found!
  - hasFileExtension
```
public static boolean hasFileExtension(File file,
                                       boolean caseSensitive,
                                       String... extensions)
```
    Checks the extension of a file for a valid one with the ones specified in the list of extensions. The option "caseSensitive" can be set if required. This functions doesn't make a difference with the OS implementations "\" or "/", both are accepted!
    
    Parameters:
    
    file - the file.
    
    caseSensitive - if case sensitivity is used or not.
    
    extensions - a variable length of file extensions without the ".", e.g. "html","htm" for HTML files.
    
    Returns:
    
    true if the file has one of the file extensions, false otherwise.
  - hasFileExtension
```
public static boolean hasFileExtension(String fileName,
                                       boolean caseSensitive,
                                       String... extensions)
```
    Checks the extension of a file for a valid one with the ones specified in the list of extensions. The option "caseSensitive" can be set if required. This functions doesn't make a difference with the OS implementations "\" or "/", both are accepted!
    
    Parameters:
    
    fileName - the file name.
    
    caseSensitive - if case sensitivity is used or not.
    
    extensions - a variable length of file extensions without the ".", e.g. "html","htm" for HTML files.
    
    Returns:
    
    true if the file has one of the file extensions, false otherwise.
  - isJarOrZipFile
```
public static boolean isJarOrZipFile(String fileName)
```
    Checks if a file is of Jar or Zip file type (i.e. has JAR or ZIP file extension, case insensitive).
  - isJarOrZipFile
```
public static boolean isJarOrZipFile(File file)
```
    Checks if a file is of Jar or Zip file type (i.e. has JAR or ZIP file extension, case insensitive).

Class PhantomFile

Field Summary

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

monthNames

dayNames

Constructor Detail

PhantomFile

PhantomFile

PhantomFile

PhantomFile

PhantomFile

PhantomFile

PhantomFile

PhantomFile

PhantomFile

PhantomFile

PhantomFile

Method Detail

loadFile

loadFile

loadFile

loadFile

loadFile

close

getFileNameFromAnother

getFileNameFromAnother

read

readString

readString

readOEMString

readOEMString

readUnicodeString

readOEMBytes

readUnicodeChars

readByte

readBoolean

readIntelUShort

readIntelShort

readIntelLong

readIntelDouble

skipBytes

getRemainingSize

getFileName

readOEMStringVector

readOEMStringVector

readOEMStringVector

readBOMStringVector

readByteLine

readOEMLine

readAnsiLine

readISOLine

getMemoryDataByte

findFileInPath

findFileInPath

findFileInDirectory

findFileInDirectory

findFilesInDirectory

findFilesInDirectory

lastModified

getFileTimestamp

getFileTimestamp

getFileTimestamp

getBaseName

isSameFile

isSameFile

getCanonicalPath

getCanonicalFile

getCanonicalPath

getCanonicalFile

getRelativeFileName

getRelativePath

getRelativePath

getRelativeFileName

getRelativeFileName

listDirectory

listDirectory