com.github.rvesse.airline.types

Class ConvertResult

java.lang.Object

com.github.rvesse.airline.types.ConvertResult

public class ConvertResult
extends Object

Helper class used to represent the result of an attempted conversion. Primarily used internally by DefaultTypeConverter but may be generally useful for implementing custom TypeConverter implementations or extending the DefaultTypeConverter

Field Summary

Fields

Modifier and Type	Field and Description
static ConvertResult	FAILURE Special constant instance used to indicate failure

Constructor Summary

Constructors

Constructor and Description
ConvertResult(Object value) Creates a new conversion result that indicates success
ConvertResult(Throwable cause)

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	getCause() Gets the cause if available
Object	getConvertedValue() The converted value
boolean	hasCause() Gets whether a cause is available
boolean	wasSuccessfull() Whether the conversion was successful

Methods inherited from class java.lang.Object

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

Field Detail

FAILURE

public static final ConvertResult FAILURE

Special constant instance used to indicate failure

Constructor Detail

ConvertResult

public ConvertResult(Object value)

Creates a new conversion result that indicates success

Parameters:

value - Converted value

ConvertResult

public ConvertResult(Throwable cause)

Method Detail

wasSuccessfull

public boolean wasSuccessfull()

Whether the conversion was successful

Returns:

True if successful, false otherwise

getConvertedValue

public Object getConvertedValue()

The converted value

Returns:

Converted value

hasCause

public boolean hasCause()

Gets whether a cause is available

Returns:

Cause

getCause

public Throwable getCause()

Gets the cause if available

Returns:

Cause, or null if none available