|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.thoughtworks.xstream.persistence.AbstractFilePersistenceStrategy
com.thoughtworks.xstream.persistence.FilePersistenceStrategy
public class FilePersistenceStrategy
PersistenceStrategy to assign keys with single value to objects persisted in files. The
default naming strategy is based on the key's type and its SingleValueConverter. It
escapes all characters that are normally illegal in the most common file systems. Such a
character is escaped with percent escaping as it is done by URL encoding. The XStream used to
marshal the values is also requested for the key's SingleValueConverter. A
StreamException is thrown if no such converter is registered.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.thoughtworks.xstream.persistence.AbstractFilePersistenceStrategy |
|---|
AbstractFilePersistenceStrategy.ValidFilenameFilter, AbstractFilePersistenceStrategy.XmlMapEntriesIterator |
| Constructor Summary | |
|---|---|
FilePersistenceStrategy(File baseDirectory)
Create a new FilePersistenceStrategy. |
|
FilePersistenceStrategy(File baseDirectory,
XStream xstream)
Create a new FilePersistenceStrategy with a provided XStream instance. |
|
FilePersistenceStrategy(File baseDirectory,
XStream xstream,
String encoding,
String illegalChars)
Create a new FilePersistenceStrategy with a provided XStream instance and the characters to encode. |
|
| Method Summary | |
|---|---|
protected String |
escape(String key)
|
protected Object |
extractKey(String name)
Given a filename, the unescape method returns the key which originated it. |
protected String |
getName(Object key)
Given a key, the escape method returns the filename which shall be used. |
protected boolean |
isValid(File dir,
String name)
|
protected String |
unescape(String name)
|
| Methods inherited from class com.thoughtworks.xstream.persistence.AbstractFilePersistenceStrategy |
|---|
containsKey, get, getConverterLookup, getMapper, iterator, put, remove, size |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FilePersistenceStrategy(File baseDirectory)
DomDriver.
baseDirectory - the directory for the serialized values
public FilePersistenceStrategy(File baseDirectory,
XStream xstream)
baseDirectory - the directory for the serialized valuesxstream - the XStream instance to use for (de)serialization
public FilePersistenceStrategy(File baseDirectory,
XStream xstream,
String encoding,
String illegalChars)
baseDirectory - the directory for the serialized valuesxstream - the XStream instance to use for (de)serializationencoding - encoding used to write the filesillegalChars - illegal characters for file names (should always include '%' as long
as you do not overwrite the (un)escape methods)| Method Detail |
|---|
protected boolean isValid(File dir,
String name)
isValid in class AbstractFilePersistenceStrategyprotected Object extractKey(String name)
extractKey in class AbstractFilePersistenceStrategyname - the filename
protected String unescape(String name)
protected String getName(Object key)
getName in class AbstractFilePersistenceStrategykey - the key
protected String escape(String key)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||