Package org.keycloak.models.map.storage.tree

Enum TreeStorageNodePrescription.FieldContainedStatus

java.lang.Object

java.lang.Enum<TreeStorageNodePrescription.FieldContainedStatus>

org.keycloak.models.map.storage.tree.TreeStorageNodePrescription.FieldContainedStatus

All Implemented Interfaces:

Serializable, Comparable<TreeStorageNodePrescription.FieldContainedStatus>

Enclosing class:

TreeStorageNodePrescription

public static enum TreeStorageNodePrescription.FieldContainedStatus
extends Enum<TreeStorageNodePrescription.FieldContainedStatus>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULLY	Field is fully contained in the storage in this node.
NOT_CONTAINED	Field is not contained in the storage in this node but parts of it might be contained in some child node as well
PARTIALLY	Field is contained in the storage in this node but parts of it might be contained in some child node as well.

Method Summary

Modifier and Type	Method	Description
TreeStorageNodePrescription.FieldContainedStatus	max(Supplier<TreeStorageNodePrescription.FieldContainedStatus> otherFunc)
TreeStorageNodePrescription.FieldContainedStatus	max(TreeStorageNodePrescription.FieldContainedStatus other)	Returns higher of this and the other field status: FULLY > PARTIALLY > NOT_CONTAINED
abstract TreeStorageNodePrescription.FieldContainedStatus	minus(TreeStorageNodePrescription.FieldContainedStatus s)	Returns the status of the field if this field status in this node was stripped off the field status s.
static TreeStorageNodePrescription.FieldContainedStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TreeStorageNodePrescription.FieldContainedStatus[]	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

FULLY

public static final TreeStorageNodePrescription.FieldContainedStatus FULLY

Field is fully contained in the storage in this node. For example, attribute foo or field NAME stored in this node would be FULLY contained field.

See Also:

PARTIALLY

PARTIALLY

public static final TreeStorageNodePrescription.FieldContainedStatus PARTIALLY

Field is contained in the storage in this node but parts of it might be contained in some child node as well. For example, a few attributes can be partially supplied from an LDAP, and the rest could be supplied from the supplementing JPA node.

This status is never used in the case of a fully specified field access but can be used for map-like attributes where the key is not specified.

NOT_CONTAINED

public static final TreeStorageNodePrescription.FieldContainedStatus NOT_CONTAINED

Field is not contained in the storage in this node but parts of it might be contained in some child node as well

Method Detail

values

public static TreeStorageNodePrescription.FieldContainedStatus[] 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 (TreeStorageNodePrescription.FieldContainedStatus c : TreeStorageNodePrescription.FieldContainedStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static TreeStorageNodePrescription.FieldContainedStatus 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

minus

public abstract TreeStorageNodePrescription.FieldContainedStatus minus(TreeStorageNodePrescription.FieldContainedStatus s)

Returns the status of the field if this field status in this node was stripped off the field status s. Specifically, for two nodes in parent/child relationship, parent.minus(child) answers the question: "How much of the field does parent contain that is not contained in the child?"

• If the field in this node is contained FULLY or PARTIALLY, and the field in the other node is contained FULLY, then there is no need to store any part of the field in this node, i.e. the result is NOT_CONTAINED
• If the field in this node is contained PARTIALLY and the field in the other node is also only contained PARTIALLY, then the portions might be disjunct, so it is still necessary to store a part of the field in this node, i.e. the result is PARTIALLY
• If the field in this node is NOT_CONTAINED at all, then the result remains NOT_CONTAINED regardless of the other node status

max

public TreeStorageNodePrescription.FieldContainedStatus max(TreeStorageNodePrescription.FieldContainedStatus other)

Returns higher of this and the other field status: FULLY > PARTIALLY > NOT_CONTAINED

max

public TreeStorageNodePrescription.FieldContainedStatus max(Supplier<TreeStorageNodePrescription.FieldContainedStatus> otherFunc)