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 Details

    • value

      private final Object value
    • success

      private final boolean success
    • cause

      private final Throwable cause
    • FAILURE

      public static final ConvertResult FAILURE
      Special constant instance used to indicate failure
  • Constructor Details

    • ConvertResult

      private ConvertResult()
      Creates a basic convert result that indicates failure
    • ConvertResult

      public ConvertResult(Object value)
      Creates a new conversion result that indicates success
      Parameters:
      value - Converted value
    • ConvertResult

      public ConvertResult(Throwable cause)
      Creates a new conversion result that indicates failure
      Parameters:
      cause - Cause of the failure
  • Method Details

    • wasSuccessful

      public boolean wasSuccessful()
      Whether the conversion was successful
      Returns:
      True if successful, false otherwise
    • wasSuccessfull

      @Deprecated public boolean wasSuccessfull()
      Deprecated.
      Use correctly spelled overload wasSuccessful() instead
      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