org.eclipse.soda.dk.file.connection
Class FileConnection

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.connection.Connection
          org.eclipse.soda.dk.connection.StreamConnection
              org.eclipse.soda.dk.file.connection.FileConnection

All Implemented Interfaces:

ConnectionService, FileConnectionService

public class FileConnection
extends StreamConnection
implements ConnectionService, FileConnectionService

File Connection. The FileConnection class implements the device service and provides the controls for the device.

The list of exported services:

Version:

1.1.0

See Also:

FileConnectionService, ConnectionService

Field Summary

static java.lang.String

CLASS_NAME Defines the class name.

Fields inherited from class org.eclipse.soda.dk.connection.Connection

CLIENT_WAIT_RESOURCE, CLOSE_RESOURCE, CLOSED_RESOURCE, configurationService, OPEN_RESOURCE, OPENFAILED_RESOURCE, READ_BYTES_RESOURCE, readByteCount, WRITE_BYTES_RESOURCE, writeByteCount

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE

Fields inherited from interface org.eclipse.soda.dk.file.connection.service.FileConnectionService

DEFAULT_INPUTNAME, DEFAULT_INPUTPATH, DEFAULT_OUTPUTNAME, DEFAULT_OUTPUTPATH, FACTORY_SERVICE_NAME, FileConnection, INPUTNAME, INPUTNAME_DEFAULT, INPUTNAME_KEY, INPUTPATH, INPUTPATH_DEFAULT, INPUTPATH_KEY, MANAGED_SERVICE_NAME, OUTPUTNAME, OUTPUTNAME_DEFAULT, OUTPUTNAME_KEY, OUTPUTPATH, OUTPUTPATH_DEFAULT, OUTPUTPATH_KEY, SERVICE_DESCRIPTION, SERVICE_NAME

Constructor Summary

FileConnection()
Constructs a standard FileConnection object.

FileConnection(ConfigurationService configuration)
Constructs an instance of this class from the specified configuration parameter.

FileConnection(java.util.Dictionary properties)

FileConnection(java.io.File inputFile, java.io.File outputFile)
Constructs an FileConnection object using the input parameter(s).

FileConnection(java.lang.String inputPath, java.lang.String inputFilename, java.lang.String outputPath, java.lang.String outputFilename)
Constructs an FileConnection object using the input parameter(s).

Method Summary

void	close() Close.
void	exit() Exit.
java.io.File	getInputFile() Gets the File inputFile property value.
java.io.File	getOutputFile() Gets the File outputFile property value.
void	open() Perform the open action method.
void	setInputFile(java.io.File inputFile) Sets the inputFile property.
void	setOutputFile(java.io.File outputFile) Sets the outputFile property.
void	toStringInfo(java.lang.StringBuffer buffer) To string info with the specified buffer parameter.

Methods inherited from class org.eclipse.soda.dk.connection.StreamConnection

flush, getInputStream, getOutputStream, read, read, setInputStream, setOutputStream, write, write

Methods inherited from class org.eclipse.soda.dk.connection.Connection

attemptRecoveryFromError, finalize, getConfigurationService, getDefaultResource, getErrorSeverity, getLogDetails4, getLogDetails5, getReadByteCount, getResource, getWriteByteCount, isOpen, setConfigurationService, setOpen, setReadByteCount, setWriteByteCount, updateReadByteCount, updateWriteByteCount

Methods inherited from class org.eclipse.soda.dk.core.EscObject

createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getCurrentTimestamp, getDefaultLogService, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

Defines the class name. Generated field and should not be changed.

See Also:

Constant Field Values

Constructor Detail

FileConnection

public FileConnection()

Constructs a standard FileConnection object. This constructor uses the default input and output names.

See Also:

FileConnection(File,File), FileConnection(String,String,String,String), FileConnection(Dictionary), FileConnection(ConfigurationService)

FileConnection

public FileConnection(java.io.File inputFile,
                      java.io.File outputFile)

Constructs an FileConnection object using the input parameter(s). java.io.File java.io.File

Parameters:

inputFile - The input file (File) parameter.

outputFile - The output file (File) parameter.

See Also:

FileConnection(), FileConnection(String,String,String,String), FileConnection(Dictionary), FileConnection(ConfigurationService)

FileConnection

public FileConnection(java.lang.String inputPath,
                      java.lang.String inputFilename,
                      java.lang.String outputPath,
                      java.lang.String outputFilename)

Constructs an FileConnection object using the input parameter(s). java.lang.String java.lang.String java.lang.String java.lang.String

Parameters:

inputPath - The input path (String) parameter.

inputFilename - The input filename (String) parameter.

outputPath - The output path (String) parameter.

outputFilename - The output filename (String) parameter.

See Also:

FileConnection(), FileConnection(File,File), FileConnection(Dictionary), FileConnection(ConfigurationService)

FileConnection

public FileConnection(java.util.Dictionary properties)

Parameters:

properties - The properties (Dictionary) parameter.

See Also:

FileConnection(), FileConnection(File,File), FileConnection(String,String,String,String), FileConnection(ConfigurationService)

FileConnection

public FileConnection(ConfigurationService configuration)

Constructs an instance of this class from the specified configuration parameter. The configuration (ConfigurationService) parameter.

Parameters:

configuration - The configuration (ConfigurationService) parameter.

See Also:

FileConnection(), FileConnection(File,File), FileConnection(String,String,String,String), FileConnection(Dictionary)

Method Detail

close

public void close()
           throws java.io.IOException

Close.

Specified by:

close in interface ConnectionService

Overrides:

close in class StreamConnection

Throws:

java.io.IOException - IOException.

See Also:

ConnectionService.close()

exit

public void exit()
          throws java.io.IOException

Exit.

Specified by:

exit in interface ConnectionService

Overrides:

exit in class Connection

Throws:

java.io.IOException - IOException.

getInputFile

public java.io.File getInputFile()

Gets the File inputFile property value.

Returns:

Results of the get input file (File) value.

See Also:

setInputFile(File)

getOutputFile

public java.io.File getOutputFile()

Gets the File outputFile property value.

Returns:

Results of the get output file (File) value.

See Also:

setOutputFile(File)

open

public void open()
          throws java.io.IOException

Perform the open action method. href="java.io.IOException.html">IOException Thrown if the IOException exception condition occurs.

Specified by:

open in interface ConnectionService

Overrides:

open in class Connection

Throws:

java.io.IOException - IOException.

See Also:

ConnectionService.open()

setInputFile

public void setInputFile(java.io.File inputFile)

Sets the inputFile property. The new property value (java.io.File).

Parameters:

inputFile - The input file (File) parameter.

See Also:

getInputFile()

setOutputFile

public void setOutputFile(java.io.File outputFile)

Sets the outputFile property. The new property value (java.io.File).

Parameters:

outputFile - The output file (File) parameter.

See Also:

getOutputFile()

toStringInfo

public void toStringInfo(java.lang.StringBuffer buffer)

To string info with the specified buffer parameter. The buffer (StringBuffer) parameter.

Overrides:

toStringInfo in class Connection

Parameters:

buffer - The buffer (StringBuffer) parameter.