org.safs.persist

Class PersistorToPropertiesFile

java.lang.Object

org.safs.persist.PersistableChecker

org.safs.persist.AbstractPersistor

org.safs.persist.AbstractRuntimeDataPersistor

org.safs.persist.PersistorToFile

org.safs.persist.PersistorToPropertiesFile

All Implemented Interfaces:

Persistor

public class PersistorToPropertiesFile
extends PersistorToFile

Write Persistable object to a Properties file, such as:

 Response.ContentType : application/xml
 Response.EntityBody : <?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">\
 \n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>\
 \n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/1/">1</CUSTOMER>\
 \n</CUSTOMERList>
 Response.EntityLength : 0
 Response.Headers : {Date=Mon, 12 Dec 2016 05:17:19 GMT, Content-Length=4762, Via=1.1 inetgw38 (squid), Connection=keep-alive, Content-Type=application/xml, X-Cache=MISS from inetgw38, Server=Apache-Coyote/1.1}
 Response.Request.Headers : Content-Type:application/octet-stream
 Accept:application/octet-stream
 

NOTE: Be careful with the value occupying multiple lines in the properties file, which should be escaped as characters \ and \n, as showed in the example above.

Author:

Lei Wang

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	PERSIST_CONTAINER

Fields inherited from class org.safs.persist.PersistorToFile

filename, ignoredFieldsForUnpickle, persistFile, reader, writer

Fields inherited from class org.safs.persist.AbstractRuntimeDataPersistor

runtime

Constructor Summary

Constructors

Constructor and Description
PersistorToPropertiesFile(RuntimeDataInterface runtime, java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	escape(java.lang.String value) Escape special characters such as value occupying multiple lines in the properties file, which should be escaped as characters \ and \n.
void	write(Persistable persistable) Write the Persistable object into a persistent material. PersistorToFile.writeHeader(Persistable) is called before PersistorToFile.writeTailer(Persistable) is called after

Methods inherited from class org.safs.persist.PersistorToFile

beforeUnpickle, doUnpickle, equals, getPersistenceName, getType, isIgnoredFiled, persist, stringNeedQuoted, unpersist, unpickle, writeHeader, writeTailer

Methods inherited from class org.safs.persist.PersistableChecker

validate

Methods inherited from class java.lang.Object

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

Field Detail

PERSIST_CONTAINER

public static final boolean PERSIST_CONTAINER

See Also:

Constant Field Values

Constructor Detail

PersistorToPropertiesFile

public PersistorToPropertiesFile(RuntimeDataInterface runtime,
                                 java.lang.String filename)

Parameters:

runtime -

filename -

Method Detail

write

public void write(Persistable persistable)
           throws SAFSException,
                  java.io.IOException

Description copied from class: PersistorToFile

Write the Persistable object into a persistent material.
PersistorToFile.writeHeader(Persistable) is called before
PersistorToFile.writeTailer(Persistable) is called after

Specified by:

write in class PersistorToFile

Throws:

SAFSException

java.io.IOException

escape

protected java.lang.String escape(java.lang.String value)

Escape special characters such as value occupying multiple lines in the properties file, which should be escaped as characters \ and \n.

Overrides:

escape in class PersistorToFile

Parameters:

value - String, the value to escape

Returns:

String, the escaped string

See Also:

PersistorToFile.stringNeedQuoted()