Enum FilterReturnCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FilterReturnCode>

    public enum FilterReturnCode
    extends java.lang.Enum<FilterReturnCode>
    Valid File Filter adapter return codes.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ConversionError
      Failure during conversion.
      CouldNotOpen
      Unable to find or open a resource required to perform the requested conversion.
      HighlightError
      Failure during conversion (e.g. to HTML) when applying highlighting.
      InitializationError
      Initialization has not yet taken place, or an error occurred during initialization.
      InvalidArgument
      A method was passed an invalid argument.
      InvalidOutputType
      The output type is not known.
      NotSupported
      The requested functionality is not yet supported.
      Success
      Operation succeeded.
      Unknown
      Other error.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getCode()
      The return code as an integer value.
      static FilterReturnCode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FilterReturnCode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • InvalidArgument

        public static final FilterReturnCode InvalidArgument
        A method was passed an invalid argument.
      • InitializationError

        public static final FilterReturnCode InitializationError
        Initialization has not yet taken place, or an error occurred during initialization.
      • NotSupported

        public static final FilterReturnCode NotSupported
        The requested functionality is not yet supported.
      • InvalidOutputType

        public static final FilterReturnCode InvalidOutputType
        The output type is not known.
      • CouldNotOpen

        public static final FilterReturnCode CouldNotOpen
        Unable to find or open a resource required to perform the requested conversion.
      • ConversionError

        public static final FilterReturnCode ConversionError
        Failure during conversion.
      • HighlightError

        public static final FilterReturnCode HighlightError
        Failure during conversion (e.g. to HTML) when applying highlighting.
    • Method Detail

      • values

        public static FilterReturnCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (FilterReturnCode c : FilterReturnCode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static FilterReturnCode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getCode

        public int getCode()
        The return code as an integer value.