All Superinterfaces:

java.lang.Comparable<DomainFile>

All Known Implementing Classes:

DomainFileProxy, GhidraFile
```
public interface DomainFile
extends java.lang.Comparable<DomainFile>
```
DomainFile provides a storage interface for project files. A DomainFile is an immutable reference to file contained within a project. The state of a DomainFile object does not track name/parent changes made to the referenced project file.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_VERSION`	Use with getDomainObject to request the default version.
`static java.lang.String`	`READ_ONLY_PROPERTY`	Event property name for Read-only setting.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addToVersionControl(java.lang.String comment, boolean keepCheckedOut, TaskMonitor monitor)`	Adds this private file to version control.
`boolean`	`canAddToRepository()`	Returns true if this private file may be added to the associated repository.
`boolean`	`canCheckin()`	Returns true if this file may be checked-in to the associated repository.
`boolean`	`canCheckout()`	Returns true if this file may be checked-out from the associated repository.
`boolean`	`canMerge()`	Returns true if this file can be merged with the current versioned file.
`boolean`	`canRecover()`	Prior to invoking getDomainObject, this method can be used to determine if unsaved changes can be recovered on the next open.
`boolean`	`canSave()`	Return whether this domain object can be saved (i.e., updated/overwritten).
`void`	`checkin(CheckinHandler checkinHandler, boolean okToUpgrade, TaskMonitor monitor)`	Performs check in to associated repository.
`boolean`	`checkout(boolean exclusive, TaskMonitor monitor)`	Checkout this file for update.
`DomainFile`	`copyTo(DomainFolder newParent, TaskMonitor monitor)`	Copy this file into the newParent folder as a private file.
`DomainFile`	`copyVersionTo(int version, DomainFolder destFolder, TaskMonitor monitor)`	Copy a specific version of this file to the specified destFolder.
`void`	`delete()`	Delete the entire database for this file, including any version files.
`void`	`delete(int version)`	Deletes a specific version of a file from the versioned filesystem.
`boolean`	`exists()`	Check for existence of domain file.
`ChangeSet`	`getChangesByOthersSinceCheckout()`	Returns changes made to versioned file by others since checkout was performed.
`ItemCheckoutStatus[]`	`getCheckouts()`	Get a list of checkouts by all users for the associated versioned file.
`ItemCheckoutStatus`	`getCheckoutStatus()`	Get checkout status associated with a versioned file.
`java.util.List<?>`	`getConsumers()`	Get the list of consumers (Objects) for this domain file.
`java.lang.String`	`getContentType()`	Returns content-type string
`DomainObject`	`getDomainObject(java.lang.Object consumer, boolean okToUpgrade, boolean okToRecover, TaskMonitor monitor)`	Opens and returns the current domain object.
`java.lang.Class<? extends DomainObject>`	`getDomainObjectClass()`	Returns the underlying Class for the domain object in this domain file.
`java.lang.String`	`getFileID()`	Returns a unique file-ID
`javax.swing.Icon`	`getIcon(boolean disabled)`	Get the state based Icon image for the domain file based upon its content class.
`DomainObject`	`getImmutableDomainObject(java.lang.Object consumer, int version, TaskMonitor monitor)`	Returns a new DomainObject that cannot be changed or saved to its original file.
`long`	`getLastModifiedTime()`	Get a long value representing the time when the data was last modified.
`int`	`getLatestVersion()`	Return the latest version
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()`	Returns an ordered map containing the metadata that has been associated with the corresponding domain object.
`java.lang.String`	`getName()`	Get the name of the StoredObj that is associated with the data.
`DomainObject`	`getOpenedDomainObject(java.lang.Object consumer)`	Returns the domainObject for this DomainFile only if it is already open.
`DomainFolder`	`getParent()`	Get the parent domain folder for this domain file.
`java.lang.String`	`getPathname()`	Returns the path name to the domain object.
`ProjectLocator`	`getProjectLocator()`	Returns the local storage location for the project that this DomainFile belongs to.
`DomainObject`	`getReadOnlyDomainObject(java.lang.Object consumer, int version, TaskMonitor monitor)`	Returns a "read-only" version of the domain object.
`int`	`getVersion()`	Return either the latest version if the file is not checked-out or the version that was checked-out or a specific version that was requested.
`Version[]`	`getVersionHistory()`	Returns list of all available versions.
`boolean`	`isBusy()`	Returns true if the domain object in this domain file exists and has an open transaction.
`boolean`	`isChanged()`	Return whether the domain object in this domain file has changed.
`boolean`	`isCheckedOut()`	Returns true if this is a checked-out file.
`boolean`	`isCheckedOutExclusive()`	Returns true if this a checked-out file with exclusive access.
`boolean`	`isHijacked()`	Returns true if the file is versioned but a private copy also exists.
`boolean`	`isInWritableProject()`	Returns true if this file is in a writable project.
`boolean`	`isLatestVersion()`	Returns true if this file represents the latest version of the associated domain object.
`boolean`	`isOpen()`	Returns true if there is an open domainObject for this file.
`boolean`	`isReadOnly()`	Returns whether the object is read-only.
`boolean`	`isVersionControlSupported()`	Returns true if the versioned filesystem can be used to store this files content type.
`boolean`	`isVersioned()`	Return true if this is a versioned database, else false
`long`	`length()`	Returns the length of this domain file.
`void`	`merge(boolean okToUpgrade, TaskMonitor monitor)`	Performs merge from current version of versioned file into local checked-out file.
`boolean`	`modifiedSinceCheckout()`	Returns true if this is a checked-out file which has been modified since it was checked-out.
`DomainFile`	`moveTo(DomainFolder newParent)`	Move this file into the newParent folder.
`void`	`packFile(java.io.File file, TaskMonitor monitor)`	Pack domain file into specified file.
`void`	`save(TaskMonitor monitor)`	Save the `DomainObject` associated with this file.
`DomainFile`	`setName(java.lang.String newName)`	Set the name on this domain file.
`void`	`setReadOnly(boolean state)`	Sets the object to read-only.
`boolean`	`takeRecoverySnapshot()`	If the file has an updatable domain object with unsaved changes, generate a recovery snapshot.
`void`	`terminateCheckout(long checkoutId)`	Forcefully terminate a checkout for the associated versioned file.
`void`	`undoCheckout(boolean keep)`	Undo "checked-out" file.

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - DEFAULT_VERSION
```
static final int DEFAULT_VERSION
```
    Use with getDomainObject to request the default version. The default version is the private file or check-out file if one exists, or the latest version from the version controlled file system.
    
    See Also:
    
    Constant Field Values
  - READ_ONLY_PROPERTY
```
static final java.lang.String READ_ONLY_PROPERTY
```
    Event property name for Read-only setting.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    Get the name of the StoredObj that is associated with the data.
    
    Returns:
    
    the name
  - exists
```
boolean exists()
```
    Check for existence of domain file.
    
    Returns:
    
    true if file exists. A proxy domain file will always return false.
  - getFileID
```
java.lang.String getFileID()
```
    Returns a unique file-ID
    
    Returns:
    
    the ID
  - setName
```
DomainFile setName(java.lang.String newName)
            throws InvalidNameException,
                   java.io.IOException
```
    Set the name on this domain file.
    
    Parameters:
    
    newName - domain file name
    
    Returns:
    
    renamed domain file (the original DomainFile object becomes invalid since it is immutable)
    
    Throws:
    
    InvalidNameException - if newName contains illegal characters
    
    DuplicateFileException - if a file named newName already exists in this files domain folder.
    
    FileInUseException - if this file is in-use / checked-out.
    
    java.io.IOException - thrown if an IO or access error occurs.
  - getPathname
```
java.lang.String getPathname()
```
    Returns the path name to the domain object.
    
    Returns:
    
    the path name
  - getProjectLocator
```
ProjectLocator getProjectLocator()
```
    Returns the local storage location for the project that this DomainFile belongs to.
    
    Returns:
    
    the location
  - getContentType
```
java.lang.String getContentType()
```
    Returns content-type string
    
    Returns:
    
    the content type
  - getDomainObjectClass
```
java.lang.Class<? extends DomainObject> getDomainObjectClass()
```
    Returns the underlying Class for the domain object in this domain file.
    
    Returns:
    
    the class
  - getParent
```
DomainFolder getParent()
```
    Get the parent domain folder for this domain file.
    
    Returns:
    
    the parent
  - getChangesByOthersSinceCheckout
```
ChangeSet getChangesByOthersSinceCheckout()
                                   throws VersionException,
                                          java.io.IOException
```
    Returns changes made to versioned file by others since checkout was performed.
    
    Returns:
    
    change set or null
    
    Throws:
    
    VersionException - latest version was created with a newer version of software
    
    java.io.IOException - if a folder item access error occurs or change set was produced by newer version of software and can not be read
  - getDomainObject
```
DomainObject getDomainObject(java.lang.Object consumer,
                             boolean okToUpgrade,
                             boolean okToRecover,
                             TaskMonitor monitor)
                      throws VersionException,
                             java.io.IOException,
                             CancelledException
```
    Opens and returns the current domain object. If the domain object is already opened, then the existing open domain object is returned.
    
    Parameters:
    
    consumer - consumer of the domain object which is responsible for releasing it after use. When all the consumers using the domain object release it, then the object is closed and its resources released.
    
    okToUpgrade - if true, allows the system to upgrade out of data domain objects to be in compliance with the current version of Ghidra. A Version exception will be thrown if the domain object cannot be upgraded OR okToUpgrade is false and the domain object is out of date.
    
    okToRecover - if true, allows the system to recover unsaved file changes which resulted from a crash. If false, any existing recovery data will be deleted. This flag is only relevant if project is open for update (isInProject) and the file can be opened for update.
    
    monitor - permits monitoring of open progress.
    
    Returns:
    
    an open domain object can be modified and saved. (Not read-only)
    
    Throws:
    
    VersionException - if the domain object could not be read due to a version format change. If okToUpgrade is true, then a VersionException indicates that the domain object cannot be upgraded to the current format. If okToUpgrade is false, then the VersionException only means the object is not in the current format - it may or may not be possible to upgrade.
    
    java.io.IOException - thrown if an IO or access error occurs.
    
    CancelledException - if monitor cancelled operation
  - getOpenedDomainObject
```
DomainObject getOpenedDomainObject(java.lang.Object consumer)
```
    Returns the domainObject for this DomainFile only if it is already open.
    
    Parameters:
    
    consumer - the consumer that will use the object.
    
    Returns:
    
    the already opened domainObject or null if it is not currently open.
  - getReadOnlyDomainObject
```
DomainObject getReadOnlyDomainObject(java.lang.Object consumer,
                                     int version,
                                     TaskMonitor monitor)
                              throws VersionException,
                                     java.io.IOException,
                                     CancelledException
```
    Returns a "read-only" version of the domain object. "Read-only" means that the domain object cannot be saved back into its original domain object. It can still be modified and saved to a new domain file. The domain object will be assigned a temporary domain file that will not allow a "save" operation. The user must do a "save as" to a new filename.
    
    Parameters:
    
    consumer - consumer of the domain object which is responsible for releasing it after use.
    
    version - the domain object version requested. DEFAULT_VERSION should be specified to open the current version.
    
    monitor - permits monitoring of open progress.
    
    Returns:
    
    a new domain object that is disassociated from its original domain file.
    
    Throws:
    
    VersionException - if the domain object could not be read due to a version format change.
    
    java.io.FileNotFoundException - if the stored file/version was not found.
    
    java.io.IOException - thrown if an IO or access error occurs.
    
    CancelledException - if monitor cancelled operation
  - getImmutableDomainObject
```
DomainObject getImmutableDomainObject(java.lang.Object consumer,
                                      int version,
                                      TaskMonitor monitor)
                               throws VersionException,
                                      java.io.IOException,
                                      CancelledException
```
    Returns a new DomainObject that cannot be changed or saved to its original file.
    
    Parameters:
    
    consumer - consumer of the domain object which is responsible for releasing it after use.
    
    version - the domain object version requested. DEFAULT_VERSION should be specified to open the current version.
    
    monitor - permits monitoring of open progress.
    
    Returns:
    
    a new domain object that is disassociated from its original domain file and cannot be modified
    
    Throws:
    
    VersionException - if the domain object could not be read due to a version format change.
    
    java.io.FileNotFoundException - if the stored file/version was not found.
    
    java.io.IOException - thrown if an IO or access error occurs.
    
    CancelledException - if monitor cancelled operation
  - save
```
void save(TaskMonitor monitor)
   throws java.io.IOException,
          CancelledException
```
    Save the DomainObject associated with this file.
    
    Parameters:
    
    monitor - monitor for the task that is doing the save on the file
    
    Throws:
    
    FileInUseException - if the file is open for update by someone else, or a transient-read is in progress.
    
    java.io.IOException - thrown if an IO error occurs.
    
    CancelledException - if monitor cancelled operation
  - canSave
```
boolean canSave()
```
    Return whether this domain object can be saved (i.e., updated/overwritten).
    
    Returns:
    
    true if the user is the owner AND the file is in the active project AND the file is not read-only.
  - canRecover
```
boolean canRecover()
```
    Prior to invoking getDomainObject, this method can be used to determine if unsaved changes can be recovered on the next open.
    
    Returns:
    
    true if recovery data exists.
  - takeRecoverySnapshot
```
boolean takeRecoverySnapshot()
                      throws java.io.IOException
```
    If the file has an updatable domain object with unsaved changes, generate a recovery snapshot.
    
    Returns:
    
    true if snapshot successful or not needed, false if file is busy which prevents snapshot, or snapshot was cancelled.
    
    Throws:
    
    java.io.IOException - if there is an exception saving the snapshot
  - isInWritableProject
```
boolean isInWritableProject()
```
    Returns true if this file is in a writable project.
    
    Returns:
    
    true if writable
  - getLastModifiedTime
```
long getLastModifiedTime()
```
    Get a long value representing the time when the data was last modified.
    
    Returns:
    
    the time
  - getIcon
```
javax.swing.Icon getIcon(boolean disabled)
```
    Get the state based Icon image for the domain file based upon its content class.
    
    Parameters:
    
    disabled - true if the icon return should be rendered as not enabled
    
    Returns:
    
    image icon
  - isCheckedOut
```
boolean isCheckedOut()
```
    Returns true if this is a checked-out file.
    
    Returns:
    
    true if checked-out
  - isCheckedOutExclusive
```
boolean isCheckedOutExclusive()
```
    Returns true if this a checked-out file with exclusive access.
    
    Returns:
    
    true if checked-out exclusively
  - modifiedSinceCheckout
```
boolean modifiedSinceCheckout()
```
    Returns true if this is a checked-out file which has been modified since it was checked-out.
    
    Returns:
    
    true if modified since check-out
  - canCheckout
```
boolean canCheckout()
```
    Returns true if this file may be checked-out from the associated repository. User's with read-only repository access will not have checkout ability.
    
    Returns:
    
    true if can checkout
  - canCheckin
```
boolean canCheckin()
```
    Returns true if this file may be checked-in to the associated repository.
    
    Returns:
    
    true if can check-in
  - canMerge
```
boolean canMerge()
```
    Returns true if this file can be merged with the current versioned file.
    
    Returns:
    
    true if can merge
  - canAddToRepository
```
boolean canAddToRepository()
```
    Returns true if this private file may be added to the associated repository.
    
    Returns:
    
    true if can add to the repository
  - setReadOnly
```
void setReadOnly(boolean state)
          throws java.io.IOException
```
    Sets the object to read-only. This method may only be invoked for private files (i.e., not versioned).
    
    Parameters:
    
    state - if true file will be read-only and may not be updated, if false the file may be updated.
    
    Throws:
    
    java.io.IOException - thrown if an IO error occurs.
  - isReadOnly
```
boolean isReadOnly()
```
    Returns whether the object is read-only. From a framework point of view a read-only object can never be changed.
    
    Returns:
    
    true if read-only
  - isVersionControlSupported
```
boolean isVersionControlSupported()
```
    Returns true if the versioned filesystem can be used to store this files content type.
    
    Returns:
    
    true if supports version control
  - isVersioned
```
boolean isVersioned()
```
    Return true if this is a versioned database, else false
    
    Returns:
    
    true if versioned
  - isHijacked
```
boolean isHijacked()
```
    Returns true if the file is versioned but a private copy also exists.
    
    Returns:
    
    true if hijacked
  - getLatestVersion
```
int getLatestVersion()
```
    Return the latest version
    
    Returns:
    
    the version
  - isLatestVersion
```
boolean isLatestVersion()
```
    Returns true if this file represents the latest version of the associated domain object.
    
    Returns:
    
    true if the latest version
  - getVersion
```
int getVersion()
```
    Return either the latest version if the file is not checked-out or the version that was checked-out or a specific version that was requested.
    
    Returns:
    
    the version
  - getVersionHistory
```
Version[] getVersionHistory()
                     throws java.io.IOException
```
    Returns list of all available versions.
    
    Returns:
    
    the versions
    
    Throws:
    
    java.io.IOException - if there is an exception getting the history
  - addToVersionControl
```
void addToVersionControl(java.lang.String comment,
                         boolean keepCheckedOut,
                         TaskMonitor monitor)
                  throws java.io.IOException,
                         CancelledException
```
    Adds this private file to version control.
    
    Parameters:
    
    comment - new version comment
    
    keepCheckedOut - if true, the file will be initially checked-out
    
    monitor - progress monitor
    
    Throws:
    
    FileInUseException - if this file is in-use.
    
    java.io.IOException - thrown if an IO or access error occurs. Also thrown if file is not private.
    
    CancelledException - if the monitor cancelled the operation
  - checkout
```
boolean checkout(boolean exclusive,
                 TaskMonitor monitor)
          throws java.io.IOException,
                 CancelledException
```
    Checkout this file for update. If this file is already private, this method does nothing.
    
    Parameters:
    
    exclusive - if true an exclusive checkout will be requested
    
    monitor - progress monitor
    
    Returns:
    
    true if checkout successful, false if an exclusive checkout was not possible due to other users having checkouts of this file. A request for a non-exclusive checkout will never return false.
    
    Throws:
    
    java.io.IOException - thrown if an IO or access error occurs.
    
    CancelledException - if task monitor cancelled operation.
  - checkin
```
void checkin(CheckinHandler checkinHandler,
             boolean okToUpgrade,
             TaskMonitor monitor)
      throws java.io.IOException,
             VersionException,
             CancelledException
```
    Performs check in to associated repository. File must be checked-out and modified since checkout.
    
    Parameters:
    
    checkinHandler - provides user input data to complete checkin process.
    
    okToUpgrade - if true an upgrade will be performed if needed
    
    monitor - the TaskMonitor.
    
    Throws:
    
    java.io.IOException - if an IO or access error occurs
    
    VersionException - if unable to handle domain object version in versioned filesystem. If okToUpgrade was false, check exception to see if it can be upgraded sometime after doing a checkout.
    
    CancelledException - if task monitor cancelled operation
  - merge
```
void merge(boolean okToUpgrade,
           TaskMonitor monitor)
    throws java.io.IOException,
           VersionException,
           CancelledException
```
    Performs merge from current version of versioned file into local checked-out file.
    
    Parameters:
    
    okToUpgrade - if true an upgrade will be performed if needed
    
    monitor - task monitor
    
    Throws:
    
    java.io.IOException - if an IO or access error occurs
    
    VersionException - if unable to handle domain object version in versioned filesystem. If okToUpgrade was false, check exception to see if it can be upgraded
    
    CancelledException - if task monitor cancelled operation
  - undoCheckout
```
void undoCheckout(boolean keep)
           throws java.io.IOException
```
    Undo "checked-out" file. The original repository file is restored.
    
    Parameters:
    
    keep - if true, the private database will be renamed with a .keep extension.
    
    Throws:
    
    FileInUseException - if this file is in-use / checked-out.
    
    java.io.IOException - thrown if file is not checked-out or an IO / access error occurs.
  - terminateCheckout
```
void terminateCheckout(long checkoutId)
                throws java.io.IOException
```
    Forcefully terminate a checkout for the associated versioned file. The user must be the owner of the checkout or have administrator privilege on the versioned filesystem (i.e., repository).
    
    Parameters:
    
    checkoutId - checkout ID
    
    Throws:
    
    java.io.IOException - if an IO or access error occurs
  - getCheckouts
```
ItemCheckoutStatus[] getCheckouts()
                           throws java.io.IOException
```
    Get a list of checkouts by all users for the associated versioned file.
    
    Returns:
    
    list of checkouts
    
    Throws:
    
    java.io.IOException - if an IO or access error occurs
  - getCheckoutStatus
```
ItemCheckoutStatus getCheckoutStatus()
                              throws java.io.IOException
```
    Get checkout status associated with a versioned file.
    
    Returns:
    
    checkout status or null if not checked-out to current associated project.
    
    Throws:
    
    java.io.IOException - if an IO or access error occurs
  - delete
```
void delete()
     throws java.io.IOException
```
    Delete the entire database for this file, including any version files.
    
    Throws:
    
    FileInUseException - if this file is in-use / checked-out.
    
    UserAccessException - if the user does not have permission to delete the file.
    
    java.io.IOException - thrown if an IO or access error occurs.
  - delete
```
void delete(int version)
     throws java.io.IOException
```
    Deletes a specific version of a file from the versioned filesystem.
    
    Parameters:
    
    version - specific version to be deleted. The version must either be the oldest or latest, or -1 which will attempt to remove all versions. When deleting the latest version, this method could take a long time to return since the previous version must be reconstructed within the versioned filesystem.
    
    Throws:
    
    java.io.IOException - if an IO error occurs, including the inability to delete a version because this item is checked-out, the user does not have permission, or the specified version is not the oldest or latest.
  - moveTo
```
DomainFile moveTo(DomainFolder newParent)
           throws java.io.IOException
```
    Move this file into the newParent folder.
    
    Parameters:
    
    newParent - new parent folder within the same project
    
    Returns:
    
    the newly relocated domain file (the original DomainFile object becomes invalid since it is immutable)
    
    Throws:
    
    DuplicateFileException - if a file with the same name already exists in newParent folder.
    
    FileInUseException - if this file is in-use / checked-out.
    
    java.io.IOException - thrown if an IO or access error occurs.
  - copyTo
```
DomainFile copyTo(DomainFolder newParent,
                  TaskMonitor monitor)
           throws java.io.IOException,
                  CancelledException
```
    Copy this file into the newParent folder as a private file.
    
    Parameters:
    
    newParent - new parent folder
    
    monitor - task monitor
    
    Returns:
    
    newly created domain file
    
    Throws:
    
    FileInUseException - if this file is in-use / checked-out.
    
    java.io.IOException - thrown if an IO or access error occurs.
    
    CancelledException - if task monitor cancelled operation.
  - copyVersionTo
```
DomainFile copyVersionTo(int version,
                         DomainFolder destFolder,
                         TaskMonitor monitor)
                  throws java.io.IOException,
                         CancelledException
```
    Copy a specific version of this file to the specified destFolder.
    
    Parameters:
    
    version - version to copy
    
    destFolder - destination parent folder
    
    monitor - task monitor
    
    Returns:
    
    the copied file
    
    Throws:
    
    java.io.IOException - thrown if an IO or access error occurs.
    
    CancelledException - if task monitor cancelled operation.
  - getConsumers
```
java.util.List<?> getConsumers()
```
    Get the list of consumers (Objects) for this domain file.
    
    Returns:
    
    empty array list if there are no consumers
  - isChanged
```
boolean isChanged()
```
    Return whether the domain object in this domain file has changed.
    
    Returns:
    
    true if changed
  - isOpen
```
boolean isOpen()
```
    Returns true if there is an open domainObject for this file.
    
    Returns:
    
    true if open
  - isBusy
```
boolean isBusy()
```
    Returns true if the domain object in this domain file exists and has an open transaction.
    
    Returns:
    
    true if busy
  - packFile
```
void packFile(java.io.File file,
              TaskMonitor monitor)
       throws java.io.IOException,
              CancelledException
```
    Pack domain file into specified file. Specified file will be overwritten if it already exists.
    
    Parameters:
    
    file - destination file
    
    monitor - the task monitor
    
    Throws:
    
    java.io.IOException - if there is an exception packing the file
    
    CancelledException - if monitor cancels operation
  - getMetadata
```
java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    Returns an ordered map containing the metadata that has been associated with the corresponding domain object. The map contains key,value pairs and are ordered by their insertion order.
    
    Returns:
    
    a map containing the metadata that has been associated with the corresponding domain object.
  - length
```
long length()
     throws java.io.IOException
```
    Returns the length of this domain file. This size is the minimum disk space used for storing this file, but does not account for additional storage space used to tracks changes, etc.
    
    Returns:
    
    file length
    
    Throws:
    
    java.io.IOException - thrown if IO or access error occurs

Interface DomainFile

Field Summary

Method Summary

Methods inherited from interface java.lang.Comparable

Field Detail

DEFAULT_VERSION

READ_ONLY_PROPERTY

Method Detail

getName

exists

getFileID

setName

getPathname

getProjectLocator

getContentType

getDomainObjectClass

getParent

getChangesByOthersSinceCheckout

getDomainObject

getOpenedDomainObject

getReadOnlyDomainObject

getImmutableDomainObject

save

canSave

canRecover

takeRecoverySnapshot

isInWritableProject

getLastModifiedTime

getIcon

isCheckedOut

isCheckedOutExclusive

modifiedSinceCheckout

canCheckout

canCheckin

canMerge

canAddToRepository

setReadOnly

isReadOnly

isVersionControlSupported

isVersioned

isHijacked

getLatestVersion

isLatestVersion

getVersion

getVersionHistory

addToVersionControl

checkout

checkin

merge

undoCheckout

terminateCheckout

getCheckouts

getCheckoutStatus

delete

delete

moveTo

copyTo

copyVersionTo

getConsumers

isChanged

isOpen

isBusy

packFile

getMetadata

length