XStream Core 1.4.20 · com.thoughtworks.xstream.annotations.XStreamConverter

Annotation to declare a converter. The annotation supports additionally the injection of various constructor arguments provided by XStream:

com.thoughtworks.xstream.mapper.Mapper: The current mapper chain of the XStream instance.
com.thoughtworks.xstream.core.ClassLoaderReference: The reference to the class loader used by the XStream instance to deserialize the objects.
com.thoughtworks.xstream.converters.reflection.ReflectionProvider: The reflection provider used by the reflection based converters of the current XStream instance.
com.thoughtworks.xstream.converters.ConverterLookup: The lookup for converters handling a special type.
All elements provided with the individual arrays of this annotation. The provided values follow the declaration sequence if a constructor requires multiple arguments of the same type.
Class: The type of the element where the annotation is declared. Note, that this argument is not supported when using com.thoughtworks.xstream.annotations.XStreamConverters or useImplicitType() == false.
com.thoughtworks.xstream.core.JVM: Utility e.g. to load classes.
ClassLoader (deprecated since 1.4.5): The class loader used by the XStream instance to deserialize the objects. Use ClassLoaderReference as argument

The algorithm will try the converter's constructor with the most arguments first.

Note, the annotation matches a ConverterMatcher. com.thoughtworks.xstream.converters.Converter as well as com.thoughtworks.xstream.converters.SingleValueConverter extend this interface. The com.thoughtworks.xstream.mapper.AnnotationMapper can only handle these two known types.

Method Summary

Modifier and Type	Method and Description
public boolean[]	booleans()
public byte[]	bytes()
public char[]	chars()
public double[]	doubles()
public float[]	floats()
public int[]	ints()
public long[]	longs()
public Class<?>[]	Returns: the types provided as null values nulls() Provide null types as arguments for the converter's constructor arguments.
public int	priority()
public short[]	shorts()
public String[]	strings()
public Class<?>[]	Returns: the types types() Provide class types as arguments for the converter's constructor arguments.
public boolean	Returns: true if the current type is provided useImplicitType() Flag to provide the current type as implicit first Class argument to a converter's constructor.
public Class<? extends ConverterMatcher>	value()

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

booleans	back to summary
public boolean[] booleans()

bytes	back to summary
public byte[] bytes()

chars	back to summary
public char[] chars()

doubles	back to summary
public double[] doubles()

floats	back to summary
public float[] floats()

ints	back to summary
public int[] ints()

longs	back to summary
public long[] longs()

nulls	back to summary
public Class<?>[] nulls() Provide null types as arguments for the converter's constructor arguments. Returns:Class<?>[] the types provided as null values Since 1.4.9

nulls

back to summary

public Class<?>[] nulls()

Provide null types as arguments for the converter's constructor arguments.

Returns:Class<?>[]: the types provided as null values
Since: 1.4.9

priority	back to summary
public int priority()

shorts	back to summary
public short[] shorts()

strings	back to summary
public String[] strings()

types back to summary

types	back to summary
public Class<?>[] types() Provide class types as arguments for the converter's constructor arguments. Note, that XStream itself provides the current class type as first Class argument to a constructor, if the annotation is added directly to a class type (and not as part of a parameter declaration of a `XStreamConverters` annotation). The current type has precedence over any type provided with this method. This behavior can be overridden setting `useImplicitType()` to false. Returns:Class<?>[] the types Since 1.4.2

public Class<?>[] types()

Provide class types as arguments for the converter's constructor arguments.

Note, that XStream itself provides the current class type as first Class argument to a constructor, if the annotation is added directly to a class type (and not as part of a parameter declaration of a XStreamConverters annotation). The current type has precedence over any type provided with this method. This behavior can be overridden setting useImplicitType() to false.

Returns:Class<?>[]: the types
Since: 1.4.2

useImplicitType	back to summary
public boolean useImplicitType() Flag to provide the current type as implicit first Class argument to a converter's constructor. Returns:boolean true if the current type is provided Since 1.4.5

useImplicitType

back to summary

public boolean useImplicitType()

Flag to provide the current type as implicit first Class argument to a converter's constructor.

Returns:boolean: true if the current type is provided
Since: 1.4.5

value	back to summary
public Class<? extends ConverterMatcher> value()

public @Interface XStreamConverter

Method Summary

Method Detail