e4s.util
Class E4BackupFile

java.lang.Object
  e4s.util.E4Object
      e4s.util.E4BackupFile

public class E4BackupFile
extends E4Object

Utility class to perform cyclic file renaming on backup files. Files from the current day are saved, files from each previous day are saved as well.

Since:

JDK 1.4

Field Summary

static java.lang.String	BACKUP_DATE Date format used for backup files.
static java.lang.String	BACKUP_TIME Time formats used for backup files.

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

E4BackupFile()

Method Summary

static java.lang.String	_getSVNVersionString()
static java.io.File	getBackupFilename(java.lang.String path, java.lang.String prefix, java.lang.String extension, boolean delete_existing) Construct a file with path + prefix + '.' + [yyyyMMdd] + [HHmmss] + '.' + extension
static boolean	rollBackupFile(java.lang.String path, E4String prefix, java.lang.String extension) Make a cyclic backup.
static boolean	rollBackupFile(java.lang.String path, java.lang.String prefix, java.lang.String extension) Make a cyclic backup.

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, toString, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BACKUP_DATE

public static final java.lang.String BACKUP_DATE

Date format used for backup files. Filenames for backup are constructed in the form prefix + '.' + [yyyyMMdd] + [HHmmss] + '.' + extension.

See Also:

BACKUP_DATE, Constant Field Values

BACKUP_TIME

public static final java.lang.String BACKUP_TIME

Time formats used for backup files.

See Also:

BACKUP_DATE, Constant Field Values

Constructor Detail

E4BackupFile

public E4BackupFile()

Method Detail

rollBackupFile

public static boolean rollBackupFile(java.lang.String path,
                                     E4String prefix,
                                     java.lang.String extension)
                              throws java.lang.Exception

Make a cyclic backup.

Parameters:

path - a directory path, ending with a File.seperator ('/' or '\\')

prefix - a filename prefix, without trailing '.'

extension - a filename extension, without starting '.'

Returns:

false on errors (date conversion)

Throws:

java.lang.Exception

See Also:

rollBackupFile( String, String, String )

rollBackupFile

public static boolean rollBackupFile(java.lang.String path,
                                     java.lang.String prefix,
                                     java.lang.String extension)
                              throws java.lang.Exception

Make a cyclic backup. Looks in the specified folder (path) for files, whos names start with prefix and end with extension. Note, that not either prefix or extension may contain a point ('.')!. The next criteria is, that between prefix and extension there is a date signature in the form prefix + '.' + [yyyyMMdd] + [HHmmss] + '.' + extension. The format for the date is specified in constants BACKUP_DATE and BACKUP_TIME. All files from today are keept undeleted. For the passed days, only the last file is keept.

Parameters:

path - a directory path, ending with a File.seperator ('/' or '\\')

prefix - a filename prefix, without trailing '.'

extension - a filename extension, without starting '.'

Returns:

false on errors (date conversion)

Throws:

java.lang.Exception

getBackupFilename

public static java.io.File getBackupFilename(java.lang.String path,
                                             java.lang.String prefix,
                                             java.lang.String extension,
                                             boolean delete_existing)

Construct a file with path + prefix + '.' + [yyyyMMdd] + [HHmmss] + '.' + extension

Parameters:

path - a directory path, ending with a File.seperator ('/' or '\\')

prefix - a filename prefix, without trailing '.'

extension - a filename extension, without starting '.'

Returns:

the new constructed File (not opened or created physically)

_getSVNVersionString

public static java.lang.String _getSVNVersionString()