com.thoughtworks.xstream.converters.reflection
Class SortableFieldKeySorter
java.lang.Object
com.thoughtworks.xstream.converters.reflection.SortableFieldKeySorter
- All Implemented Interfaces:
- FieldKeySorter, Caching
public class SortableFieldKeySorter
- extends Object
- implements FieldKeySorter, Caching
The default implementation for sorting fields. Invoke registerFieldOrder in order to set the
field order for an specific type.
- Since:
- 1.2.2
- Author:
- Guilherme Silveira
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SortableFieldKeySorter
public SortableFieldKeySorter()
sort
public Map sort(Class type,
Map keyedByFieldKey)
- Description copied from interface:
FieldKeySorter
- Sort the fields of a type. The method will be called with the class type that contains
all the fields and a Map that retains the order in which the elements have been added.
The sequence in which elements are returned by an iterator defines the processing order
of the fields. An implementation may create a different Map with similar semantic, add
all elements of the original map and return the new one.
- Specified by:
sort
in interface FieldKeySorter
- Parameters:
type
- the class that contains all the fieldskeyedByFieldKey
- a Map containing a FieldKey
as key element and a
Field
as value.
- Returns:
- a Map with all the entries of the original Map
registerFieldOrder
public void registerFieldOrder(Class type,
String[] fields)
- Registers the field order to use for a specific type. This will not affect any of the
type's super or sub classes. If you skip a field which will be serialized, XStream will
thrown an StreamException during the serialization process.
- Parameters:
type
- the typefields
- the field order
flushCache
public void flushCache()
- Specified by:
flushCache
in interface Caching
Copyright © 2004-2014 XStream. All Rights Reserved.