Enum Class LinkType
- All Implemented Interfaces:
Serializable,Comparable<LinkType>,Constable
Determines how a child property value is linked to the parent object
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe json property value will be embedded in the parent objectThe property value will be linked to the parent object via an ID, usually the DbIdThe property value will be not be exposed in the parent objectThe property value will be exposed as a separate sub-query -
Method Summary
Modifier and TypeMethodDescriptionfindByNameOrLabel(String value) Find a LinkType by name or labelfromNameOrLabels(String value) Find a LinkType by name or labelstatic LinkTypeReturns the enum constant of this class with the specified name.static LinkType[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
EMBEDDED
The json property value will be embedded in the parent object -
ID
The property value will be linked to the parent object via an ID, usually the DbId -
SUB_QUERY
The property value will be exposed as a separate sub-query -
NONE
The property value will be not be exposed in the parent object
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
findByNameOrLabel
Find a LinkType by name or label- Parameters:
value- the name or label of the LinkType- Returns:
- an Optional containing the LinkType that has the provided name or label or an empty Optional if the name of label does not match any LinkType
-
fromNameOrLabels
Find a LinkType by name or label- Parameters:
value- the name or label of the LinkType- Returns:
- a successful Response containing the LinkType that has the provided name or label or a failed Response if the name of label does not match any LinkType
-