org.springframework.binding.mapping.results

Class Success

java.lang.Object

org.springframework.binding.mapping.results.AbstractMappingResult

org.springframework.binding.mapping.results.Success

All Implemented Interfaces:

java.io.Serializable, MappingResult

public class Success
extends AbstractMappingResult

Indicates a successful mapping operation.

Author:

Keith Donald

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Success(Mapping mapping, java.lang.Object mappedValue, java.lang.Object originalValue) Creates a new success result.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCode() The mapping result code; for example, "success" , "typeMismatch", "propertyNotFound", or "evaluationException".
java.lang.Throwable	getErrorCause() Get the cause of the error result
java.lang.Object	getMappedValue() The actual value that was mapped to the target object.
java.lang.Object	getOriginalValue() The original value of the source object that was to be mapped.
boolean	isError() Indicates if this result is an error result.

Methods inherited from class org.springframework.binding.mapping.results.AbstractMappingResult

getMapping, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Success

public Success(Mapping mapping,
       java.lang.Object mappedValue,
       java.lang.Object originalValue)

Creates a new success result.

Parameters:

mappedValue - the successfully mapped value

originalValue - the original value

Method Detail

getCode

public java.lang.String getCode()

Description copied from interface: MappingResult

The mapping result code; for example, "success" , "typeMismatch", "propertyNotFound", or "evaluationException".

Specified by:

getCode in interface MappingResult

Specified by:

getCode in class AbstractMappingResult

isError

public boolean isError()

Description copied from interface: MappingResult

Indicates if this result is an error result.

Specified by:

isError in interface MappingResult

Specified by:

isError in class AbstractMappingResult

getErrorCause

public java.lang.Throwable getErrorCause()

Description copied from interface: MappingResult

Get the cause of the error result

Specified by:

getErrorCause in interface MappingResult

Specified by:

getErrorCause in class AbstractMappingResult

Returns:

the underyling cause, or null if this is not an error or there was no root cause.

getOriginalValue

public java.lang.Object getOriginalValue()

Description copied from interface: MappingResult

The original value of the source object that was to be mapped. May be null if this result is an error on the source object.

Specified by:

getOriginalValue in interface MappingResult

Specified by:

getOriginalValue in class AbstractMappingResult

getMappedValue

public java.lang.Object getMappedValue()

Description copied from interface: MappingResult

The actual value that was mapped to the target object. Null if this result is an error.

Specified by:

getMappedValue in interface MappingResult

Specified by:

getMappedValue in class AbstractMappingResult