Interface ExportFile
public interface ExportFile
This interface represents a project export file existing on the
server.
- Since:
- 4.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumThe type of the export file. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturns the date of the export orUNKNOWN_EXPORT_DATEif the date of the export is unknown.Returns the version string of the FirstSpirit version which created this export file.longReturns the length of the export file or-1if content length is unknown (e.g. for directories)getName()Returns the file name of this export file.
e.g. myProject.tar.gzintgetParts()Returns the amount of parts of this exportfileReturns the project name of the export file.getType()Returns the type of this export filebooleanisBackup()Returns true is this file is in backup directory.booleanisParted()Indicates whether this export file is parted or not.
-
Field Details
-
UNKNOWN_EXPORT_DATE
- Since:
- 4.0.52
-
UNKNOWN_EXPORT_VERSION
- Since:
- 4.0.52
- See Also:
-
SNAPSHOT_EXPORT_SUFFIX
- Since:
- 4.1.16
- See Also:
-
INCREMENTAL_BACKUP_EXTENSION
- Since:
- 4.1.16
- See Also:
-
DIFFERENTIAL_BACKUP_EXTENSION
- Since:
- 4.1.16
- See Also:
-
TGZ_EXTENSION
- Since:
- 4.1.21
- See Also:
-
SNAPSHOT_EXPORT_EXTENSION
- Since:
- 4.1.21
- See Also:
-
-
Method Details
-
getExportVersion
String getExportVersion()Returns the version string of the FirstSpirit version which created this export file.- Returns:
- the export version or
UNKNOWN_EXPORT_VERSIONif the export version is unknown. - Since:
- 4.0.52
-
getExportDate
Date getExportDate()Returns the date of the export orUNKNOWN_EXPORT_DATEif the date of the export is unknown.- Since:
- 4.0.52
-
getProjectName
String getProjectName()Returns the project name of the export file.- Since:
- 4.0.52
-
getName
String getName()Returns the file name of this export file.
e.g. myProject.tar.gz- Since:
- 4.0
-
getLength
long getLength()Returns the length of the export file or-1if content length is unknown (e.g. for directories)- Since:
- 4.0
-
isParted
boolean isParted()Indicates whether this export file is parted or not.- Since:
- 4.0
- See Also:
-
getParts
int getParts()Returns the amount of parts of this exportfile- Since:
- 4.0
- See Also:
-
getType
ExportFile.ExportType getType()Returns the type of this export file- Since:
- 4.0
-
isBackup
boolean isBackup()Returns true is this file is in backup directory.- Since:
- 4.2.3
-