Package net.sf.basedb.core
Enum Class Include
- All Implemented Interfaces:
Serializable
,Comparable<Include>
,Constable
This enumeration defines constants that are used to specify which items
to include in a query.
- Version:
- 2.0
- Author:
- Nicklas
- See Also:
- 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 ConstantDescriptionInclude items that have at least one annotation.Include items in the active project.Include item owned by the logged in user.Include items that have no annotations.Include items flagged as not removed.Include items owned by other users.Include items flagged as removed.Include items shared to the logged in user. -
Field Summary
Modifier and TypeFieldDescriptionstatic final Collection<Include>
A non-modifable collection containing all options.private final int
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfromInt
(int includes) Convert an integer value to a set of includes.private int
getValue()
static int
static Include
Returns the enum constant of this class with the specified name.static Include[]
values()
Returns an array containing the constants of this enum class, 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 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
-
getValue
private int getValue() -
toInt
-
fromInt
Convert an integer value to a set of includes.
-