Class AuditStatus
- java.lang.Object
-
- com.inductiveautomation.ignition.common.util.AuditStatus
-
- All Implemented Interfaces:
java.io.Serializable
public class AuditStatus extends java.lang.Object implements java.io.Serializable
Some stuff used to rely on StatusCode#getRawValue() and StatusCode#toString(), but now StatusCode isn't available for use. This is basically a copy of StatusCode so we don't fuck up backwards compatibility somehow.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AuditStatus.InfoType
static class
AuditStatus.Severity
static class
AuditStatus.SubCode
-
Field Summary
Fields Modifier and Type Field Description static AuditStatus
BAD
static AuditStatus
BAD_DEMO_EXPIRED
static AuditStatus
BAD_INTERNAL_ERROR
static AuditStatus
BAD_SECURITY_CHECKS_FAILED
static AuditStatus
GOOD
static int
SEMANTICS_CHANGED_MASK
static int
STRUCTURE_CHANGED_MASK
static AuditStatus
UNCERTAIN
protected int
value
-
Constructor Summary
Constructors Constructor Description AuditStatus(int value)
AuditStatus(AuditStatus.SubCode subcode)
Creates a new status code with the given SubCode and false for the datavalue flag.AuditStatus(AuditStatus.SubCode subcode, boolean datavalue)
Creates a new status code based on the given SubCodeAuditStatus(AuditStatus.SubCode subCode, AuditStatus.Severity severity)
AuditStatus(AuditStatus.SubCode subCode, AuditStatus.Severity severity, boolean dataValue)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
short
getInfoBits()
Returns the InfoBits of the StatusCode (bits 0:9).AuditStatus.InfoType
getInfoType()
java.lang.String
getName()
short
getRawSubCode()
int
getRawValue()
AuditStatus.Severity
getSeverity()
AuditStatus.SubCode
getSubCode()
int
hashCode()
boolean
isGood()
boolean
isSemanticsChanged()
boolean
isStructureChanged()
java.lang.String
toString()
static AuditStatus
worstOf(AuditStatus q1, AuditStatus q2)
Returns the 'worst' or 'most severe' of the two qualities.static AuditStatus
worstOfAll(AuditStatus... q)
-
-
-
Field Detail
-
GOOD
public static final AuditStatus GOOD
-
UNCERTAIN
public static final AuditStatus UNCERTAIN
-
BAD
public static final AuditStatus BAD
-
BAD_SECURITY_CHECKS_FAILED
public static final AuditStatus BAD_SECURITY_CHECKS_FAILED
-
BAD_INTERNAL_ERROR
public static final AuditStatus BAD_INTERNAL_ERROR
-
BAD_DEMO_EXPIRED
public static final AuditStatus BAD_DEMO_EXPIRED
-
STRUCTURE_CHANGED_MASK
public static final int STRUCTURE_CHANGED_MASK
- See Also:
- Constant Field Values
-
SEMANTICS_CHANGED_MASK
public static final int SEMANTICS_CHANGED_MASK
- See Also:
- Constant Field Values
-
value
protected int value
-
-
Constructor Detail
-
AuditStatus
public AuditStatus(int value)
-
AuditStatus
public AuditStatus(AuditStatus.SubCode subCode, AuditStatus.Severity severity)
-
AuditStatus
public AuditStatus(AuditStatus.SubCode subCode, AuditStatus.Severity severity, boolean dataValue)
-
AuditStatus
public AuditStatus(AuditStatus.SubCode subcode)
Creates a new status code with the given SubCode and false for the datavalue flag.
-
AuditStatus
public AuditStatus(AuditStatus.SubCode subcode, boolean datavalue)
Creates a new status code based on the given SubCode
-
-
Method Detail
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
getSeverity
public AuditStatus.Severity getSeverity()
-
isGood
public boolean isGood()
-
getRawSubCode
public short getRawSubCode()
-
getSubCode
public AuditStatus.SubCode getSubCode()
-
isStructureChanged
public boolean isStructureChanged()
-
isSemanticsChanged
public boolean isSemanticsChanged()
-
getInfoType
public AuditStatus.InfoType getInfoType()
-
getInfoBits
public short getInfoBits()
Returns the InfoBits of the StatusCode (bits 0:9). The structure of these bits depends on the InfoType
-
getRawValue
public int getRawValue()
-
worstOf
public static AuditStatus worstOf(AuditStatus q1, AuditStatus q2)
Returns the 'worst' or 'most severe' of the two qualities.
-
worstOfAll
public static AuditStatus worstOfAll(AuditStatus... q)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getName
public java.lang.String getName()
-
-