Interface FieldKeySorter

All Known Implementing Classes:
ImmutableFieldKeySorter, NativeFieldKeySorter, SortableFieldKeySorter, XStream12FieldKeySorter

public interface FieldKeySorter
An interface capable of sorting fields. Implement this interface if you want to customize the field order in which XStream serializes objects.
Since:
1.2.2
  • Method Summary

    Modifier and Type
    Method
    Description
    sort(Class type, Map keyedByFieldKey)
    Sort the fields of a type.
  • Method Details

    • sort

      Map sort(Class type, Map keyedByFieldKey)
      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.
      Parameters:
      type - the class that contains all the fields
      keyedByFieldKey - a Map containing a FieldKey as key element and a Field as value.
      Returns:
      a Map with all the entries of the original Map
      Since:
      1.2.2