DCDriverFileCommands (SAFS API DOCUMENT)

java.lang.Object
- org.safs.Processor
- - org.safs.DriverCommand
  - - org.safs.DCDriverFileCommands

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface
```
public class DCDriverFileCommands
extends DriverCommand
```
DCDriverFileCommands, process a file driver commands instantiated by DCDriverCommand

Since:

Sep 23, 2003

Author:

Doug Bauman

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CASEINSENSITIVE` "CASEINSENSITIVE"
`static java.lang.String`	`CLOSEFILE`
`static java.lang.String`	`COPYFILE`
`static java.lang.String`	`COPYMATCHINGFILES`
`static java.lang.String`	`CREATEDIRECTORY`
`static java.lang.String`	`CREATEFILE`
`static java.lang.String`	`DELETEDIRECTORY`
`static java.lang.String`	`DELETEDIRECTORYCONTENTS`
`static java.lang.String`	`DELETEFILE`
`static java.lang.String`	`FILTERIMAGE`
`static java.lang.String`	`FILTERTEXTFILE`
`static java.lang.String`	`FINDSQAFILE`
`static java.lang.String`	`FINDSUBSTRINGINFILE`
`static java.lang.String`	`GETFILEDATETIME`
`static java.lang.String`	`GETFILEPROTECTIONS`
`static java.lang.String`	`GETFILES`
`static java.lang.String`	`GETFILESIZE`
`static java.lang.String`	`GETINIFILEVALUE`
`static java.lang.String`	`GETSTRINGCOUNTINFILE`
`static java.lang.String`	`GETSUBSTRINGSINFILE`
`static java.lang.String`	`GETTEXTFROMIMAGE`
`static java.lang.String`	`IFEXISTDIR`
`static java.lang.String`	`IFEXISTFILE`
`static java.lang.String`	`ISENDOFFILE`
`static java.lang.String`	`ONFILEEOFGOTOBLOCKID`
`static java.lang.String`	`OPENFILE`
`static java.lang.String`	`OPENUTF8FILE`
`static java.lang.String`	`PRINTTOFILE`
`static java.lang.String`	`READFILECHARS`
`static java.lang.String`	`READFILELINE`
`static java.lang.String`	`RENAMEFILE`
`static java.lang.String`	`SAVETEXTFROMIMAGE`
`static java.lang.String`	`SETFILEPROTECTIONS`
`static java.lang.String`	`UTF8_ENCODING` "UTF-8"
`static byte[]`	`UTF8_MARKER` the 3 marker bytes at the beginning of a UTF-8 file--and the first line
`static java.lang.String`	`WRITEFILECHARS`

Fields inherited from class org.safs.DriverCommand
command, iterator, utils

Fields inherited from class org.safs.Processor
breakpointsOn, CASE_INSENSITIVE_FLAG, CASEINSENSITIVE_FLAG, clearProxiesAlways, commandLineBreakpoint, customStr, customText, DEBUG_MESSAGE, debugStr, debugText, DEFAULT_CUSTOM_PROCESSOR_PACKAGE, DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE, DEFAULT_PROCESSOR_PACKAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, failedStr, failedText, FAILURE_DETAIL, GENERIC_MESSAGE, genericStr, genericText, LINE_FAILURE_4, log, myBreakpointsOn, otherStr, otherText, PARAM_SIZE_1, PARAM_SIZE_2, PARAM_SIZE_3, PARAM_SIZE_4, params, PASSED_MESSAGE, passedStr, passedText, PRE_TXT_SUCCESS_4, PRE_TXT_SUCCESS_5, processorConfigSet, processorMap, recordProcessed, RECTYPE_DRIVER_COMMAND, RECTYPE_DRIVER_COMMAND_F, RECTYPE_DRIVER_COMMAND_W, RECTYPE_TEST_STEP, RECTYPE_TEST_STEP_F, RECTYPE_TEST_STEP_W, RFSMCache, RFSMOnly, RFT_FIND_SEARCH_MODE_ALGORITHM, RFT_FIND_SEARCH_MODE_CACHE, SAFS_CLEARPROXIESALWAYS_ITEM, SAFS_COMMANDLINEBREAKPOINT_ITEM, SAFS_COMMANDLINEBREAKPOINT_VARIABLE, SAFS_PARAMS_FILE, SAFS_RESBUN_NAME, SAFS_SECSWAITFORCOMPONENT_ITEM, SAFS_SECSWAITFORCOMPONENT_VARIABLE, SAFS_SECSWAITFORWINDOW_ITEM, SAFS_SECSWAITFORWINDOW_VARIABLE, SAFS_TESTDOMAINS_ITEM, SAFS_TESTDOMAINS_VARIABLE, secsWaitForComponent, secsWaitForWindow, SENT_MSG_3, testDomains, testRecordData, testrecordStackable, TXT_FAILURE_1, TXT_FAILURE_2, TXT_FAILURE_3, TXT_FAILURE_4, TXT_FAILURE_5, TXT_SUCCESS_1, TXT_SUCCESS_2, TXT_SUCCESS_2a, TXT_SUCCESS_3, TXT_SUCCESS_3a, TXT_SUCCESS_4, TXT_SUCCESS_5, unexpectedAlertBehaviour, WARNING_MESSAGE, WARNING_OK_MESSAGE, warningStr, warningText

Constructor Summary

Constructors
Constructor and Description

DCDriverFileCommands()

Purpose: constructor, calls super

Constructors
Constructor and Description
`DCDriverFileCommands()` Purpose: constructor, calls super

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Map`	`getfileMap()`
`void`	`process()` Purpose: process: process the testRecordData This is the driver command processor for file commands.

Methods inherited from class org.safs.Processor
activateBreakpoint, checkBreakpoints, checkMyBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAlternateParams, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcClassNames, getCustomProcInstancePath, getLogUtilities, getParams, getProcClassNames, getProcInstance, getProcInstancePath, getRequiredField, getSecsWaitForComponent, getSecsWaitForWindow, getStandardErrorMessage, getTestRecordData, getUnexpectedAlertBehaviour, getVariable, hasChainedProcessor, initProcessorAndProcess, instanceProcessorAndProcess, isBreakpointsOn, isComponentFunctionRecord, isDriverCommandRecord, isEngineCommandRecord, isMyBreakpointsOn, isRecordProcessed, isRFSMCache, isRFSMOnly, issueActionFailure, issueActionOnXFailure, issueErrorPerformingAction, issueErrorPerformingActionOnX, issueErrorPerformingActionUsing, issueInputRecordFailure, issueInputRecordFailure, issuePassedSuccess, logFailureMessage, normalizeTestFileName, paramsFailedMsg, paramsFailedMsg, popTestRecord, processCustomProcessor, processSubclassProcessor, pushTestRecord, setAtEndOfProcess, setBreakpointsOn, setChainedProcessor, setClearProxiesAlways, setCommandLineBreakpoint, setCustomProcInstancePath, setLogUtilities, setMyBreakpointsOn, setParams, setProcInstance, setProcInstancePath, setRecordProcessed, setRFSMCache, setRFSMOnly, setSecsWaitForComponent, setSecsWaitForWindow, setTestDomains, setTestRecordData, setUnexpectedAlertBehaviour, setVariable, standardFailureMessage, substituteVariable, validateParamSize, validProcessorClassName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLOSEFILE
```
public static final java.lang.String CLOSEFILE
```
    See Also:
    
    Constant Field Values
  - COPYFILE
```
public static final java.lang.String COPYFILE
```
    See Also:
    
    Constant Field Values
  - COPYMATCHINGFILES
```
public static final java.lang.String COPYMATCHINGFILES
```
    See Also:
    
    Constant Field Values
  - CREATEDIRECTORY
```
public static final java.lang.String CREATEDIRECTORY
```
    See Also:
    
    Constant Field Values
  - CREATEFILE
```
public static final java.lang.String CREATEFILE
```
    See Also:
    
    Constant Field Values
  - DELETEDIRECTORY
```
public static final java.lang.String DELETEDIRECTORY
```
    See Also:
    
    Constant Field Values
  - DELETEDIRECTORYCONTENTS
```
public static final java.lang.String DELETEDIRECTORYCONTENTS
```
    See Also:
    
    Constant Field Values
  - DELETEFILE
```
public static final java.lang.String DELETEFILE
```
    See Also:
    
    Constant Field Values
  - FILTERTEXTFILE
```
public static final java.lang.String FILTERTEXTFILE
```
    See Also:
    
    Constant Field Values
  - FINDSQAFILE
```
public static final java.lang.String FINDSQAFILE
```
    See Also:
    
    Constant Field Values
  - FINDSUBSTRINGINFILE
```
public static final java.lang.String FINDSUBSTRINGINFILE
```
    See Also:
    
    Constant Field Values
  - GETSUBSTRINGSINFILE
```
public static final java.lang.String GETSUBSTRINGSINFILE
```
    See Also:
    
    Constant Field Values
  - GETSTRINGCOUNTINFILE
```
public static final java.lang.String GETSTRINGCOUNTINFILE
```
    See Also:
    
    Constant Field Values
  - GETFILEDATETIME
```
public static final java.lang.String GETFILEDATETIME
```
    See Also:
    
    Constant Field Values
  - GETFILESIZE
```
public static final java.lang.String GETFILESIZE
```
    See Also:
    
    Constant Field Values
  - GETFILES
```
public static final java.lang.String GETFILES
```
    See Also:
    
    Constant Field Values
  - IFEXISTDIR
```
public static final java.lang.String IFEXISTDIR
```
    See Also:
    
    Constant Field Values
  - IFEXISTFILE
```
public static final java.lang.String IFEXISTFILE
```
    See Also:
    
    Constant Field Values
  - OPENFILE
```
public static final java.lang.String OPENFILE
```
    See Also:
    
    Constant Field Values
  - OPENUTF8FILE
```
public static final java.lang.String OPENUTF8FILE
```
    See Also:
    
    Constant Field Values
  - PRINTTOFILE
```
public static final java.lang.String PRINTTOFILE
```
    See Also:
    
    Constant Field Values
  - WRITEFILECHARS
```
public static final java.lang.String WRITEFILECHARS
```
    See Also:
    
    Constant Field Values
  - READFILECHARS
```
public static final java.lang.String READFILECHARS
```
    See Also:
    
    Constant Field Values
  - READFILELINE
```
public static final java.lang.String READFILELINE
```
    See Also:
    
    Constant Field Values
  - RENAMEFILE
```
public static final java.lang.String RENAMEFILE
```
    See Also:
    
    Constant Field Values
  - GETFILEPROTECTIONS
```
public static final java.lang.String GETFILEPROTECTIONS
```
    See Also:
    
    Constant Field Values
  - SETFILEPROTECTIONS
```
public static final java.lang.String SETFILEPROTECTIONS
```
    See Also:
    
    Constant Field Values
  - ISENDOFFILE
```
public static final java.lang.String ISENDOFFILE
```
    See Also:
    
    Constant Field Values
  - GETINIFILEVALUE
```
public static final java.lang.String GETINIFILEVALUE
```
    See Also:
    
    Constant Field Values
  - FILTERIMAGE
```
public static final java.lang.String FILTERIMAGE
```
    See Also:
    
    Constant Field Values
  - ONFILEEOFGOTOBLOCKID
```
public static final java.lang.String ONFILEEOFGOTOBLOCKID
```
    See Also:
    
    Constant Field Values
  - GETTEXTFROMIMAGE
```
public static final java.lang.String GETTEXTFROMIMAGE
```
    See Also:
    
    Constant Field Values
  - SAVETEXTFROMIMAGE
```
public static final java.lang.String SAVETEXTFROMIMAGE
```
    See Also:
    
    Constant Field Values
  - UTF8_MARKER
```
public static final byte[] UTF8_MARKER
```
    the 3 marker bytes at the beginning of a UTF-8 file--and the first line
  - UTF8_ENCODING
```
public static final java.lang.String UTF8_ENCODING
```
    "UTF-8"
    
    See Also:
    
    Constant Field Values
  - CASEINSENSITIVE
```
public static final java.lang.String CASEINSENSITIVE
```
    "CASEINSENSITIVE"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DCDriverFileCommands
```
public DCDriverFileCommands()
```
    Purpose: constructor, calls super
- Method Detail
  - process
```
public void process()
```
    Purpose: process: process the testRecordData
    This is the driver command processor for file commands. Current commands :
    CloseFile, CopyFile, CreateDirectory, CreateFile, DeleteDirectory, DeleteFile, GetFileDateTime, GetFileSize, GetFiles, OpenFile, PrintToFile, ReadFileChars, ReadFileLine, ReadFileString, RenameFile IfExistDir, IfExistFile, WriteFileChars, GetFileProtections, SetFileProtections, IsEndOfFile, GetINIFileValue, FilterImage
    
    Side Effects: Processor.testRecordData statusCode is set based on the result of the processing; processedCommand is set to false if we do not recognize this command
    State Read: Processor.testRecordData, Processor.params
    Assumptions: none
    
    Overrides:
    
    process in class DriverCommand
  - getfileMap
```
public static java.util.Map getfileMap()
```

Class DCDriverFileCommands

Field Summary

Fields inherited from class org.safs.DriverCommand

Fields inherited from class org.safs.Processor

Constructor Summary

Method Summary

Methods inherited from class org.safs.DriverCommand

Methods inherited from class org.safs.Processor

Methods inherited from class java.lang.Object

Field Detail

CLOSEFILE

COPYFILE

COPYMATCHINGFILES

CREATEDIRECTORY

CREATEFILE

DELETEDIRECTORY

DELETEDIRECTORYCONTENTS

DELETEFILE

FILTERTEXTFILE

FINDSQAFILE

FINDSUBSTRINGINFILE

GETSUBSTRINGSINFILE

GETSTRINGCOUNTINFILE

GETFILEDATETIME

GETFILESIZE

GETFILES

IFEXISTDIR

IFEXISTFILE

OPENFILE

OPENUTF8FILE

PRINTTOFILE

WRITEFILECHARS

READFILECHARS

READFILELINE

RENAMEFILE

GETFILEPROTECTIONS

SETFILEPROTECTIONS

ISENDOFFILE

GETINIFILEVALUE

FILTERIMAGE

ONFILEEOFGOTOBLOCKID

GETTEXTFROMIMAGE

SAVETEXTFROMIMAGE

UTF8_MARKER

UTF8_ENCODING

CASEINSENSITIVE

Constructor Detail

DCDriverFileCommands

Method Detail

process

getfileMap