Enum Class DataClassification

java.lang.Object

java.lang.Enum<DataClassification>

com.kingsrook.qqq.backend.core.actions.ai.DataClassification

All Implemented Interfaces:

Serializable, Comparable<DataClassification>, Constable

public enum DataClassification
extends Enum<DataClassification>

Data sensitivity, ordered from least to most sensitive. Null means not classified and is less sensitive than every declared value.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONFIDENTIAL	Business-confidential information.
PHI	Protected health information under HIPAA.
PII	Personally identifiable information.
PUBLIC	May be shown to anyone.

Method Summary

Modifier and Type	Method	Description
boolean	isAtLeast(DataClassification other)	Whether this classification is at least as sensitive as other.
static DataClassification	max(DataClassification a, DataClassification b)	The more sensitive classification; null loses to any declared value.
static DataClassification	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataClassification[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PUBLIC

public static final DataClassification PUBLIC

May be shown to anyone.

CONFIDENTIAL

public static final DataClassification CONFIDENTIAL

Business-confidential information.

PII

public static final DataClassification PII

Personally identifiable information.

PHI

public static final DataClassification PHI

Protected health information under HIPAA.

Method Details

values

public static DataClassification[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DataClassification valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isAtLeast

public boolean isAtLeast(DataClassification other)

Whether this classification is at least as sensitive as other. Every classification is at least as sensitive as null.

max

public static DataClassification max(DataClassification a,
 DataClassification b)

The more sensitive classification; null loses to any declared value. Returns null when both values are null.