DocumentStatus - GroupDocs.Search for Java - API Reference

Packages

java.lang.Object
- java.lang.Enum<DocumentStatus>
- - com.groupdocs.search.common.DocumentStatus

All Implemented Interfaces:

Serializable, Comparable<DocumentStatus>
```
public enum DocumentStatus
extends Enum<DocumentStatus>
```
Represents a document processing status.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ProcessedWithError` Error occurred during document indexing.
`Skipped` Document skipped.
`SuccessfullyProcessed` Document successfully indexed.

Method Summary

Methods
Modifier and Type	Method and Description
`static DocumentStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DocumentStatus[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SuccessfullyProcessed
```
public static final DocumentStatus SuccessfullyProcessed
```
    Document successfully indexed.
  - Skipped
```
public static final DocumentStatus Skipped
```
    Document skipped.
  - ProcessedWithError
```
public static final DocumentStatus ProcessedWithError
```
    Error occurred during document indexing.
- Method Detail
  - values
```
public static DocumentStatus[] 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 (DocumentStatus c : DocumentStatus.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentStatus valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null