Package org.epics.pvdata.pv
Interface Status
-
- All Superinterfaces:
Serializable
public interface Status extends Serializable
Status interface.- Author:
- mse
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classStatus.StatusTypeStatus type enum.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetMessage()Get error message describing an error.StringgetStackDump()Get stack dump where error (exception) happened.Status.StatusTypegetType()Get status type.booleanisOK()Convenient OK test.booleanisSuccess()Check if operation succeeded.-
Methods inherited from interface org.epics.pvdata.pv.Serializable
deserialize, serialize
-
-
-
-
Method Detail
-
getType
Status.StatusType getType()
Get status type.- Returns:
- status type, non-
null.
-
getMessage
String getMessage()
Get error message describing an error. Required if error status.- Returns:
- error message
-
getStackDump
String getStackDump()
Get stack dump where error (exception) happened. Optional.- Returns:
- stack dump.
-
isOK
boolean isOK()
Convenient OK test. Same as(getType() == StatusType.OK). NOTE: this will returnfalseon WARNING message although operation succeeded. To check if operation succeeded, useisSuccess.- Returns:
- OK status
- See Also:
isSuccess()
-
isSuccess
boolean isSuccess()
Check if operation succeeded.- Returns:
- operation success status
-
-