Class NamedArrayConverter

  • All Implemented Interfaces:
    Converter, ConverterMatcher

    public class NamedArrayConverter
    extends java.lang.Object
    implements Converter
    An array converter that uses predefined names for its items.

    To be used as local converter.

    Since:
    1.4.6
    • Field Detail

      • arrayType

        private final java.lang.Class arrayType
      • itemName

        private final java.lang.String itemName
      • mapper

        private final Mapper mapper
    • Constructor Detail

      • NamedArrayConverter

        public NamedArrayConverter​(java.lang.Class arrayType,
                                   Mapper mapper,
                                   java.lang.String itemName)
        Construct a NamedArrayConverter.
        Parameters:
        arrayType -
        mapper -
        itemName -
        Since:
        1.4.6
    • Method Detail

      • canConvert

        public boolean canConvert​(java.lang.Class type)
        Description copied from interface: ConverterMatcher
        Determines whether the converter can marshall a particular type.
        Specified by:
        canConvert in interface ConverterMatcher
        Parameters:
        type - the Class representing the object type to be converted
      • marshal

        public void marshal​(java.lang.Object source,
                            HierarchicalStreamWriter writer,
                            MarshallingContext context)
        Description copied from interface: Converter
        Convert an object to textual data.
        Specified by:
        marshal in interface Converter
        Parameters:
        source - The object to be marshalled.
        writer - A stream to write to.
        context - A context that allows nested objects to be processed by XStream.