com.klg.jclass.util.io
Class OutputProperties

java.lang.Object
  |
  +--com.klg.jclass.util.io.Properties
        |
        +--com.klg.jclass.util.io.OutputProperties

All Implemented Interfaces:

Cloneable, Serializable

Direct Known Subclasses:

OutputDataProperties

public class OutputProperties

extends Properties

Encapsulate the properties that may be needed to save a file (such as a data file or image file)

See Also:

Serialized Form

Field Summary

protected int	fileAccess
protected String	outputFileName
protected String	propertyName
protected String	saveType

Fields inherited from class com.klg.jclass.util.io.Properties

ABSOLUTE, CHARSET_ASCII, CHARSET_ISO, CHARSET_UTF_8, charsets, DEFAULT_ACCESS, DEFAULT_CHARSET_NAME, fileAccess_i18n_strings, fileAccess_strings, fileAccess_values, ignoreExternalResourceExceptions, RELATIVE_URL, RESOLVING_CLASS, SERVLET, URL

Constructor Summary

OutputProperties()
Default constructor.

OutputProperties(String propertyName, int fileAccess)
Constructor which specifies output fileName, propertyName, saveType, and fileAccess

OutputProperties(String outputFileName, String propertyName, String saveType, int fileAccess)
Constructor which specifies output fileName, propertyName, saveType, and fileAccess

Method Summary

int	getFileAccess() Gets the type of file access.
String	getOutputFileName() Returns the file name of the actual output file to write to (if null, nothing is written)
String	getPropertyName() Gets the name to write to the property.
String	getSaveType() Gets the type of file to save.
void	setFileAccess(int fileAccess) Sets the type of file access.
void	setOutputFileName(String outputFileName) Sets the file name of the actual output file to write to (if null, nothing is written)
void	setPropertyName(String propertyName) Sets the name to write to the property.
void	setSaveType(String saveType) Sets the type of file to save.

Methods inherited from class com.klg.jclass.util.io.Properties

clone, getDefaultAccess, getFileAccessEnumFromString, getFileAccessStringFromEnum, ignoreExternalResourceExceptions, setIgnoreExternalResourceExceptions

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outputFileName

protected String outputFileName

propertyName

protected String propertyName

saveType

protected String saveType

fileAccess

protected int fileAccess

Constructor Detail

OutputProperties

public OutputProperties()

Default constructor. Use default values for all properties.

OutputProperties

public OutputProperties(String propertyName,
                        int fileAccess)

Constructor which specifies output fileName, propertyName, saveType, and fileAccess

Parameters:

propertyName - Name to write to the property

fileAccess - Type of access to file. Must be one of Properties.DEFAULT_ACCESS, Properties.ABSOLUTE, Properties.RESOLVING_CLASS, Properties.URL, Properties.RELATIVE_URL, Properties.SERVLET

OutputProperties

public OutputProperties(String outputFileName,
                        String propertyName,
                        String saveType,
                        int fileAccess)

Constructor which specifies output fileName, propertyName, saveType, and fileAccess

Parameters:

outputFileName - Name of actual output file to write to (if null, nothing is written out)

propertyName - Name to write to the property

saveType - The type of file to save

fileAccess - Type of access to file. Must be one of Properties.DEFAULT_ACCESS, Properties.ABSOLUTE, Properties.RESOLVING_CLASS, Properties.URL, Properties.RELATIVE_URL, Properties.SERVLET

Method Detail

getOutputFileName

public String getOutputFileName()

Returns the file name of the actual output file to write to (if null, nothing is written)

Returns:

The file name of the actual output file to write to

setOutputFileName

public void setOutputFileName(String outputFileName)

Sets the file name of the actual output file to write to (if null, nothing is written)

Parameters:

outputFileName - The file name of the actual output file to write to

getPropertyName

public String getPropertyName()

Gets the name to write to the property. This name is interpreted based on the file access type. It could be a filename or a Url.

Returns:

The name to write to the property

setPropertyName

public void setPropertyName(String propertyName)

Sets the name to write to the property. This name is interpreted based on the file access type. It could be a filename or a Url.

Parameters:

propertyName - The new name to write to the property

getSaveType

public String getSaveType()

Gets the type of file to save. This save type might differ, depending on how this object is used.

Returns:

The type of file to save

setSaveType

public void setSaveType(String saveType)

Sets the type of file to save. This save type might differ, depending on how this object is used.

Parameters:

saveType - The new way to save the file

getFileAccess

public int getFileAccess()

Gets the type of file access. Will be one of: Properties.DEFAULT_ACCESS, Properties.ABSOLUTE, Properties.RESOLVING_CLASS, Properties.URL, Properties.RELATIVE_URL, Properties.SERVLET

Returns:

The current type of file access.

setFileAccess

public void setFileAccess(int fileAccess)

Sets the type of file access. Must be one of: Properties.DEFAULT_ACCESS, Properties.ABSOLUTE, Properties.RESOLVING_CLASS, Properties.URL, Properties.RELATIVE_URL, Properties.SERVLET

Parameters:

fileAccess - The new file access type