Method Detail

• int backup(MaterialRepository fromMR, TSuiteResultId tSuiteResultId, boolean scan)

  copy a set of Material files idenfified by a pair of a tSuiteName and a specific tSuiteTimestamp from the project's Materials folder (fromMR) into this Material Storage.

  throws:

  IOException

  Parameters:

  fromMR

  tSuiteResultId

  scan - whether to call this.scan after backing up this TSuiteResultId

  Returns:

  number of files transfered

• int backup(MaterialRepository fromMR, java.util.List<TSuiteResultId> tSuiteResultIdList)

  copy a set of Material files identified by a pair of a tSuiteName and a RetrievalBy object from the project's Materials folder (fromMR) into this Material Storage.

  throws:

  IOException

  Parameters:

  fromMR

  tSuiteReultId

  scan - if true, fromMR.scan() will be called; otherwise no scan() will be called

  Returns:

  number of files transfered

• int clear(TSuiteResultId tSuiteResultId)

  copy all Material files in the project's Materials folder (fromMR) at the timing of invokation into this Material Storage

  throws:

  IOException

  Parameters:

  fromMR

  Returns:

  number of files transfered

• int clear(java.util.List<TSuiteResultId> tSuiteResultIdList)

• int clear(TSuiteName tSuiteName)

  delete all of subdirectories and material files which belong to the tSuiteName in this Material Storage. Will remove the tSuiteName directory.

  throws:

  IOException

  Parameters:

  tSuiteName

  Returns:

  number of Material files deleted. number of deleted directories are not included.

• void empty()

  delete all Material files in this Material Storage, keep the baseDir undeleted.

  throws:

  IOException

  Returns:

  number of Matrial files deleted

• java.nio.file.Path getBaseDir()

  Returns:

  the baseDir Path

• java.util.Set<java.nio.file.Path> getSetOfMaterialPathRelativeToTSuiteName(TSuiteName tSuiteName, TExecutionProfile tExecutionProfile)

  Parameters:

  tSuiteName

  Returns:

• long getSize()

  Returns:

  sum of the size of Material files contained in the Storage

• long reduce(long targetBytes)

  Calculate the total file size in the Storage to check if it exceeds the target size in bytes. All of TSuiteNames are inspected as possible deletion target. If exceeding, clear older TSuiteResults to reduce the total less than the target. e.g., MaterialStorage.reduceSizeTo(20 * 1000 * 1000 * 1000); // 20 giga-bytes

  Parameters:

  targetBytes - want to make the Storage size less than this

  Returns:

  the size of the Storage after reduction = sum of remaining Material files

• RestoreResult restore(MaterialRepository intoMR, TSuiteResultId tSuiteResultId, boolean scan)

  copy a set of Material files idenfified by a pair of a tSuiteName and a specific tSuiteTimestamp from this Material Storage into the project's Materials folder (intoMR).

  throws:

  IOException

  Parameters:

  intoMR

  tSuiteResultId

  scan - wither to call scan() after restoring this TSuiteResultId

  Returns:

  RestoreResult containing a TSuiteResult and int count of copied files

• java.util.List<RestoreResult> restore(MaterialRepository intoMR, java.util.List<TSuiteResultId> tSuiteResultIdList)

  copy a set of Material files identified by a pair of a tSuiteName and a RetrievalBy object from this Material Storage into the project's Materials folder (intoMR).

  throws:

  IOException

  Parameters:

  intoMR

  tSuiteName

  retrievalBy

  Returns:

  RestoreResult containing a TSuiteResult and int count of Material files transfered

• RestoreResult retrievingRestoreUnaryExclusive(MaterialRepository intoMR, TSuiteName tSuiteName, TExecutionProfile tExecutionProfile, RetrievalBy retrievalBy)

• RestoreResult retrievingRestoreUnaryInclusive(MaterialRepository intoMR, TSuiteName tSuiteName, TExecutionProfile tExecutionProfile, RetrievalBy retrievalBy)

• void scan()

  scan the Storage directory to refresh memory so that it sync with the file system

• void status(java.io.Writer output, java.util.Map<java.lang.String, java.lang.Object> options)

  list the current status of the Storage

  Parameters:

  options

  Returns:

  a string containing lines which includes TSuiteName, TSuiteTimestamp, sum of file size

• java.lang.String toJsonText()