public static enum Document.BasicState extends Enum<Document.BasicState> implements Document.State
Document.State
interface, you may have to extend or re-implement those
commands.Enum Constant and Description |
---|
BUSY
This
Document.State has a meaning similar to LOADING . |
CLOSED
Usually this
Document.State marks the end of a Document 's lifecycle and is its terminal
Document.State . |
LOADING
If this
Document.State is set, it marks a Document as loading and therefore still
incomplete. |
READY
This state marks a
Document as being ready for use. |
UNKNOWN
Marks a
Document as being in an unusual, unexpected, or generally unspecified state. |
Modifier and Type | Method and Description |
---|---|
static Document.BasicState |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Document.BasicState[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final Document.BasicState READY
public static final Document.BasicState LOADING
Document.State
is set, it marks a Document
as loading and therefore still
incomplete. It might be already useful but some parts of it may be missing.
Reader and Fluent Reader API both set this Document.State
when loading into a Document
begins. Usually, it need not be used by integrators directly. BUSY is a semantically similar
alternative.
public static final Document.BasicState BUSY
Document.State
has a meaning similar to LOADING
. It is intended to be used
by integrators in situations in which Document
s are being restructured or in some other
way worked with and therefore not ready for other uses. BUSY has a broader range of applications
than LOADING
which specifically indicates a loading process by the Reader or
Fluent Reader API.public static final Document.BasicState CLOSED
Document.State
marks the end of a Document
's lifecycle and is its terminal
Document.State
. After a Document
has been disposed of it will be in this Document.State
. It
is also possible to set this state directly and transition from it to some other Document.State
as
long as the Document
has not yet been disposed of. In this case, CLOSED can take the
meaning of "temporarily closed".public static final Document.BasicState UNKNOWN
Document
as being in an unusual, unexpected, or generally unspecified state. This
could be the result of a processing error, but need not necessarily be.public static Document.BasicState[] values()
for (Document.BasicState c : Document.BasicState.values()) System.out.println(c);
public static Document.BasicState valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2024 levigo holding gmbh. All rights reserved.