IRISLIB database
JavaFile Class Reference
Inheritance diagram for JavaFile:
Collaboration diagram for JavaFile:

Public Attributes

 createsInterface
   More...
 
 isInterface
   More...
 
- Public Attributes inherited from File
 CanonicalName
 Read only property that returns the canonical filename if the file is open and "" if the file is not open. More...
 
 DateCreated
 The creation date for this file (rounded to the millisecond). More...
 
 DateModified
 The last modified date for this file (rounded to the millisecond). More...
 
 IsOpen
 True (1) if this file is currently open, false (0) otherwise. More...
 
 Name
 The name of this file. More...
 
- Public Attributes inherited from AbstractStream
 Attributes
 An array of strings containing any attribute values associated with this stream. More...
 
 LineTerminator
 Type of line terminator we use for this stream, defaults to Cr/Lf. More...
 
- Public Attributes inherited from Object
 AtEnd
 The AtEnd property is set to true (1) when, during a read,. More...
 
 LastModified
 LastModified is a read-only property containing the <class>TimeStamp</class> of More...
 
 Size
 Size is a read-only property containing the current size of the stream (in bytes More...
 

Additional Inherited Members

- Public Member Functions inherited from File
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status Clear ()
 Clear the contents of this Stream from permanent storage. More...
 
 Close ()
 Close the current file.
 
_.Library.Status CopyFromAndSave (_.Library.AbstractStream source)
 Method not implemented as it does not make sense in context of File interface.
 
_.Library.Status Open (_.Library.String mode, _.Library.Integer timeout)
 Open the current file with mode mode. More...
 
_.Library.RawString Read (_.Library.Integer len, _.Library.Status sc)
 Read up to len characters from this File.
 
_.Library.Status Rewind ()
 Moves the current location to the beginning of the stream.
 
_.Library.Boolean SetFileDateModified (_.Library.String filename, _.Library.TimeStamp ntime, _.Library.Boolean utc, _.Library.Integer return)
 Set the date last modified of file filename to be ntime in $H format. More...
 
_.Library.Status Write (_.Library.RawString data)
 Write data to this <CLASS>File</CLASS> object.
 
_.Library.Status WriteLine (_.Library.RawString data)
 Write data with a carriage return to this <CLASS>File</CLASS> object.
 
- Public Member Functions inherited from AbstractStream
_.Library.Status CopyFrom (_.Stream.Object source)
 Copies the contents of source into this Stream. More...
 
_.Library.Boolean DeleteAttribute (_.Library.String name)
 Removes this attribute variable from the collection. More...
 
_.Library.Status Flush ()
 Flush any output in the stream not already saved.
 
_.Library.String GetAttribute (_.Library.String name, _.Library.String default)
 Retrieves the named attribute value.
 
_.Library.String GetStreamId ()
 Returns an full id value (including class name) with which the Stream implementation has stored. More...
 
_.Library.Boolean IsDefinedAttribute (_.Library.String name)
 Returns true if the named attribute variable exists in the collection, false otherwise.
 
_.Library.Boolean IsNull ()
 Returns true if this is a "NULL" stream; that is, a stream which has never. More...
 
_.Library.Status MoveToEnd ()
 Move to the end of the stream so the next <METHDO>Write</METHOD> will be appended to the end. More...
 
_.Library.String NextAttribute (_.Library.String name)
 Retrieves the next attribute variable name in the sequence, skip any '' names.
 
_.Library.AbstractStream ReadLineIntoStream ()
 This reads from the stream until it find the <property>LineTerminator</property> and returns. More...
 
_.Library.Status SaveStream ()
 Deprecated method, use <method>Save</method> instead. More...
 
 SetAttribute (_.Library.String name, _.Library.String value)
 Inserts an attribute variable by name into the collection.
 
- Public Member Functions inherited from Object
_.Library.Status AcquireLock (locktype)
 Acquires a lock for the current instance. More...
 
_.Library.Status OnAfterSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnOpen ()
 This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
 
_.Library.Status OnReload ()
 This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
 
_.Library.Status OnRollBack ()
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status CopyFrom (_.Stream.Object source)
 Copies the contents of source into this Stream. More...
 
_.Library.Status CopyFromAndSave (_.Stream.Object source)
 Copy the stream from source into the current stream ignoring anything already in the current stream. More...
 
_.Library.Integer FindAt (_.Library.Integer position, _.Library.RawString target, _.Library.RawString tmpstr, _.Library.Boolean caseinsensitive)
 Find the first occurrence of target in the stream, starting the search at position. More...
 
_.Library.Status InputFromDevice (_.Library.Integer len, _.Library.Integer timeout)
 Input len characters from the current device into the stream. More...
 
_.Library.Boolean MoveTo (_.Library.Integer position)
 Move to this position in the stream. More...
 
_.Library.Status OutputToDevice (_.Library.Integer len)
 Write out len characters of the stream to the current device starting from the current position. More...
 
_.Library.Status OutputToDeviceAt (_.Library.Integer position, _.Library.Integer length)
 Output the stream to the current device starting at position of length. More...
 
_.Library.RawString Read (_.Library.Integer len, _.Library.Status sc)
 Reads up to len characters from the current position. More...
 
_.Library.RawString ReadLine (_.Library.Integer len, _.Library.Status sc, _.Library.Boolean eol)
 Read a line from the stream. More...
 
_.Library.String ReadSQL (_.Library.Integer start, _.Library.Integer end)
 SQL specific method for reading stream data.
 
_.Library.Status SerializeToSyncSet (_.SYNC.SyncSet ss, _.Library.Integer iPtr, _.Library.String property)
 SerializeToSyncSet copies the stream value from the current object to the sync set global. More...
 
_.Library.Status SyncStreamIn (_.SYNC.SyncSet ss, _.Library.Integer iPtr, _.Library.String property)
 SyncStreamIn copies the stream value from the sync set global into the current object.
 
_.Library.Status Write (_.Library.RawString data)
 Appends the string data to the stream and advances the. More...
 
_.Library.Status WriteLine (_.Library.RawString data)
 Appends the string data along with a line terminator to the stream and advances the. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Member Functions inherited from File
_.Library.String Attributes (_.Library.String filename)
 Return the attributes of the file. More...
 
_.Library.String CanonicalFilename (_.Library.String filename)
 Returns the canonical form of the filename. More...
 
_.Library.Boolean Compare (_.Library.String file1, _.Library.String file2)
 Compare two files and return 1 if they are identical and 0 otherwise.
 
_.Library.Boolean ComplexDelete (_.Library.String filename, _.Library.Integer return)
 Handle delete of cases where filename contains a wildcard. More...
 
_.Library.String ComputeFullDBDir (_.Library.String filename)
 Return the canonical form of the directory name filename. More...
 
_.Library.String Construct (_.Library.String dirs)
 Pass in an array of paths you want to turn into a filename for the server platform, for example: More...
 
_.Library.Boolean CopyDir (_.Library.String pSource, _.Library.String pTarget, _.Library.Boolean pOverlay, pCreated, _.Library.Boolean pDeleteBeforeCopy)
 Copy a host directory from pSource to pTarget. More...
 
_.Library.Boolean CopyFile (_.Library.String from, _.Library.String to, _.Library.Boolean pDeleteBeforeCopy, _.Library.Integer return)
 Copy a host file from to host file to. More...
 
_.Library.Boolean CreateDirectory (_.Library.String name, _.Library.Integer return)
 Creates a directory with name name. More...
 
_.Library.Boolean CreateDirectoryChain (_.Library.String name, _.Library.Integer return)
 Create this directory and all the parent directories if they do not exist. More...
 
_.Library.Boolean CreateNewDir (_.Library.String directory, _.Library.String name, _.Library.Integer return)
 Given a directory name and the name of a new directory create this directory inside. More...
 
 Deconstruct (_.Library.String filename, _.Library.String dirs)
 Pass in a full valid filename for the server platform and it will decompose it into the dirs array. More...
 
_.Library.Boolean Delete (_.Library.String filename, _.Library.Integer return)
 Deletes the file filename. More...
 
_.Library.Boolean DirectoryExists (_.Library.String filename)
 Tests if filename is a directory. More...
 
_.Library.Boolean Exists (_.Library.String filename, _.Library.Integer return)
 Returns true (1) if filename exists. More...
 
_.Library.String GetDirectory (_.Library.String name, _.Library.Boolean keepterm)
 Given a full directory and filename this will return just the directory portion of this name. More...
 
_.Library.Integer GetDirectoryLength (_.Library.String name)
 Return the number of pieces in this directory name.
 
_.Library.String GetDirectoryPiece (_.Library.String name, _.Library.Integer piece, _.Library.String fullpath, _.Library.Boolean IsDrive)
 Return the piece of a directory name.
 
_.Library.Status GetDirectorySpace (_.Library.String Name, _.Library.String FreeSpace, _.Library.String TotalSpace, _.Library.Integer Flag)
 Return the amount of total space and free space in either Bytes,MB,GB on a drive or directory. More...
 
_.Library.String GetFileDateCreated (_.Library.String filename, _.Library.Boolean utc)
 Return the date created of file filename in $H format,. More...
 
_.Library.String GetFileDateModified (_.Library.String filename, _.Library.Boolean utc)
 Return the date last modified of file filename in $H format. More...
 
_.Library.String GetFileSHA256Hash (_.Library.String filename, sc)
 Return the SHA 256 hash of file filename.
 
_.Library.Integer GetFileSize (_.Library.String filename)
 Return the size of file filename in bytes.
 
_.Library.String GetFilename (_.Library.String name)
 Given a full directory and filename this will return just the filename portion of this name. More...
 
_.Library.Status GetOwnerGroup (_.Library.String File, _.Library.String OwnerGroup)
 Return the Owner and Group of a file or directory in the format Owner:Group. More...
 
_.Library.String ManagerDirectory ()
 Returns the path of the manager directory.
 
_.Library.String NormalizeDirectory (_.Library.String directory, _.Library.String absolutedirectory, _.Library.Boolean addnull)
 Returns a normalized absolute directory from the directory that is passed in including any trailing directory delimiter. More...
 
_.Library.String NormalizeFilename (_.Library.String filename, _.Library.String directory)
 Returns the normalized form of the filename. More...
 
_.Library.String NormalizeFilenameWithSpaces (_.Library.String pathname)
 Normalize filenames containing spaces for the host platform. More...
 
_.Library.String ParentDirectoryName (_.Library.String directory)
 Given a directory name, return the name of its parent directory. More...
 
_.Library.Boolean ReadOnly (_.Library.String filename)
 Return true if the file is read only and false if it is writable.
 
_.Library.Boolean RemoveDirectory (_.Library.String name, _.Library.Integer return)
 Removes directory name. More...
 
_.Library.Boolean RemoveDirectoryTree (_.Library.String pTarget)
 Recursively remove directory pTarget. More...
 
_.Library.Boolean Rename (_.Library.String oldname, _.Library.String newname, _.Library.Integer return)
 Rename file oldname to newname. More...
 
_.Library.String SHA1Hash (_.Library.String file, _.Library.Integer type)
 Return binary form of SHA1 hash on the file if type is 0 (the default). More...
 
_.Library.Boolean SetAttributes (_.Library.String filename, _.Library.String attributes, _.Library.Integer return)
 Set the OS specific attributes of the file. More...
 
_.Library.Status SetOwnerGroup (filename, OwnerGroup)
 Set the Owner and Group of a file or directory. More...
 
_.Library.Boolean SetReadOnly (_.Library.String filename, _.Library.Boolean leaveexisting, _.Library.Integer return)
 Make this file/directory read only (if we can). More...
 
_.Library.Integer SetUMask (_.Library.Integer NewMask)
 Set umask to the given value and return the previous umask value. More...
 
_.Library.Boolean SetWriteable (_.Library.String filename, _.Library.Boolean writeonly, _.Library.Integer return)
 Make this file/directory writable (if we can). More...
 
_.Library.String SubDirectoryName (_.Library.String directory, _.Library.String name, _.Library.Boolean normalized)
 Given a directory name and the name of a sub directory create the name for the. More...
 
_.Library.String TempFilename (_.Library.String ext, _.Library.String dir, _.Library.Integer return)
 Return a temporary filename in the OS provided temp directory or the directory. More...
 
_.Library.Boolean Truncate (_.Library.String filename, _.Library.Integer return)
 Truncate an existing file or create a new empty file. More...
 
_.Library.Boolean Writeable (_.Library.String filename)
 Return true if the file/directory is writable and false if it is not.
 
- Static Public Member Functions inherited from AbstractStream
_.Library.Status DeleteStream (_.Library.ObjectIdentity oid, _.Library.Integer concurrency)
 Deprecated method, use <method>Delete</method> instead. More...
 
- Static Public Member Functions inherited from Object
_.Library.String GetLockReference (_.Library.String pLocation, _.Library.String pId)
 Returns the global reference used to lock the current stream object. More...
 
_.Library.Status OnDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
_.Library.String IsCharacter ()
 Return true if this is a character stream and false if it is a binary stream.
 
_.Library.Boolean StreamOIDIsNull (_.Library.ObjectIdentity soid)
 Return true if this stream oid is a null stream and false if the stream is not null.
 
- Static Public Attributes inherited from File
 SQLPUBLICSECURITY = None
 
- Static Public Attributes inherited from AbstractStream
 MAXLEN = None
 The maximum number of characters (or bytes) allowed in a stream.
 
 PROPERTYVALIDATION = None
 Turns off property validation.
 
- Static Public Attributes inherited from Object
 DEFAULTCONCURRENCY = None
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Member Data Documentation

◆ createsInterface

createsInterface

 

 

◆ isInterface

isInterface