Module com.github.rvesse.airline
Package com.github.rvesse.airline.types

Class ConvertResult

  • public class ConvertResult
extends java.lang.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 Description
      private java.lang.Throwable cause  
      static ConvertResult FAILURE
      Special constant instance used to indicate failure
      private boolean success  
      private java.lang.Object value  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ConvertResult()
      Creates a basic convert result that indicates failure
        ConvertResult​(java.lang.Object value)
      Creates a new conversion result that indicates success
        ConvertResult​(java.lang.Throwable cause)
      Creates a new conversion result that indicates failure

    • Field Detail

      • value

        private final java.lang.Object value

      • success

        private final boolean success

      • cause

        private final java.lang.Throwable cause

      • FAILURE

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

    • Constructor Detail

      • ConvertResult

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

      • ConvertResult

        public ConvertResult​(java.lang.Object value)
        Creates a new conversion result that indicates success
        Parameters:
        value - Converted value

      • ConvertResult

        public ConvertResult​(java.lang.Throwable cause)
        Creates a new conversion result that indicates failure
        Parameters:
        cause - Cause of the failure

    • Method Detail

      • 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 java.lang.Object getConvertedValue()
        The converted value
        Returns:
        Converted value

      • hasCause

        public boolean hasCause()
        Gets whether a cause is available
        Returns:
        Cause

      • getCause

        public java.lang.Throwable getCause()
        Gets the cause if available
        Returns:
        Cause, or null if none available