org.scijava.convert

Class ConversionRequest

java.lang.Object

org.scijava.convert.ConversionRequest

public class ConversionRequest
extends Object

Currency for use in Converter and ConvertService methods.

ConversionRequest(java.lang.Object, java.lang.reflect.Type, java.lang.reflect.Type) provides a variety of constructors. Note that only one destination type needs to be set (e.g. either a Type or a Class).

Only the Class source needs to be set for Converter lookup, such as through ConvertService#getHandler(ConversionRequest). However, to perform an actual conversion, e.g. using Converter.convert(ConversionRequest), you must provide an Object source.

NB: once a Converter has been acquired, the ConversionRequest used for lookup can be reused to cast to the same destination type, simply by updating the source object using the setSourceObject(Object) method.

Author:

Mark Hiner, Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
ConversionRequest(Object src, Type destType)
ConversionRequest(Object src, Type srcType, Type destType)
ConversionRequest(Type srcType, Type destType)

Method Summary

Modifier and Type	Method and Description
Class<?>	destClass()
Type	destType()
void	setSourceObject(Object o) Sets the source object for this ConversionRequest.
Class<?>	sourceClass()
Object	sourceObject()
Type	sourceType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConversionRequest

public ConversionRequest(Object src,
                         Type destType)

ConversionRequest

public ConversionRequest(Type srcType,
                         Type destType)

ConversionRequest

public ConversionRequest(Object src,
                         Type srcType,
                         Type destType)

Method Detail

sourceType

public Type sourceType()

Returns:

Source type for conversion or lookup.

sourceClass

public Class<?> sourceClass()

Returns:

Source class for conversion or lookup.

sourceObject

public Object sourceObject()

Returns:

Source object for conversion.

destType

public Type destType()

Returns:

Destination type for conversion.

destClass

public Class<?> destClass()

Returns:

Destination class for conversion.

setSourceObject

public void setSourceObject(Object o)

Sets the source object for this ConversionRequest.

Throws:

IllegalArgumentException - If the class of the provided object does not match sourceClass().