Package net.sf.basedb.core
Enum Include
- All Implemented Interfaces:
Serializable
,Comparable<Include>
,java.lang.constant.Constable
public enum Include extends Enum<Include>
This enumeration defines constants that are used to specify which items
to include in a query.
- Version:
- 2.0
- Author:
- Nicklas
- See Also:
EntityQuery.include(Include[])
- Last modified
- $Date: 2009-04-06 14:52:39 +0200 (må, 06 apr 2009) $
-
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 ANNOTATED
Include items that have at least one annotation.IN_PROJECT
Include items in the active project.MINE
Include item owned by the logged in user.NOT_ANNOTATED
Include items that have no annotations.NOT_REMOVED
Include items flagged as not removed.OTHERS
Include items owned by other users.REMOVED
Include items flagged as removed.SHARED
Include items shared to the logged in user. -
Field Summary
Fields Modifier and Type Field Description static Collection<Include>
ALL
A non-modifable collection containing all options.private int
value
-
Constructor Summary
Constructors Modifier Constructor Description private
Include(int value)
Constructor for Permission enums. -
Method Summary
Modifier and Type Method Description (package private) static Set<Include>
fromInt(int includes)
Convert an integer value to a set of includes.private int
getValue()
static int
toInt(Set<Include> includes)
static Include
valueOf(String name)
Returns the enum constant of this type with the specified name.static Include[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
REMOVED
Include items flagged as removed. -
NOT_REMOVED
Include items flagged as not removed. -
ANNOTATED
Include items that have at least one annotation. -
NOT_ANNOTATED
Include items that have no annotations. -
MINE
Include item owned by the logged in user. -
OTHERS
Include items owned by other users. Requires generic read permission for the type of item. -
SHARED
Include items shared to the logged in user. -
IN_PROJECT
Include items in the active project.
-
-
Field Details
-
ALL
A non-modifable collection containing all options.- Since:
- 2.5
-
value
private final int value
-
-
Constructor Details
-
Include
private Include(int value)Constructor for Permission enums.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
getValue
private int getValue() -
toInt
-
fromInt
Convert an integer value to a set of includes.
-