+UserClass +

From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- doc/uk/org/ury/backend/database/UserClass.html | 376 +++++++++++++++++++++++++ 1 file changed, 376 insertions(+) create mode 100644 doc/uk/org/ury/backend/database/UserClass.html (limited to 'doc/uk/org/ury/backend/database/UserClass.html') diff --git a/doc/uk/org/ury/backend/database/UserClass.html b/doc/uk/org/ury/backend/database/UserClass.html new file mode 100644 index 0000000..f403954 --- /dev/null +++ b/doc/uk/org/ury/backend/database/UserClass.html @@ -0,0 +1,376 @@ + + + + + + +UserClass + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

+DETAIL: ENUM CONSTANTS | FIELD | METHOD

+ + + +

+ +

+ +uk.org.ury.backend.database +
+Enum UserClass

+java.lang.Object
+  java.lang.Enum<UserClass>
+      uk.org.ury.backend.database.UserClass
+

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<UserClass>

public enum UserClass
extends java.lang.Enum<UserClass>
extends java.lang.Enum<UserClass>

+ + +

+The various user classes of the database driver. + + These refer to various users in the database proper, and thus grant various + levels of permission to the program. + + Please use the least privileged user class that works. For most cases, + READ_ONLY should work perfectly. +

+ +

Author:: Matt Windsor

+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
READ_ONLY + +
+
READ_WRITE + +
+
+ + + + + + + + + + + +
+Field Summary
+ java.lang.String configName + +
+          The name of the tag in the configuration file that contains the + credentials for this user class.
+ + + + + + + + + + + + + + + + +
+Method Summary
+static UserClass valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static UserClass[] values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+ +

+Enum Constant Summary
`READ_ONLY` + + +
`READ_WRITE` + + +

+Field Summary
+ `java.lang.String`	`configName` + + + The name of the tag in the configuration file that contains the + credentials for this user class.

+Method Summary
+`static UserClass`	`valueOf(java.lang.String name)` + + + Returns the enum constant of this type with the specified name.
+`static UserClass[]`	`values()` + + + Returns an array containing the constants of this enum type, in +the order they are declared.

Methods inherited from class java.lang.Enum
`compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

+ + + + + + + + +
+Enum Constant Detail
+ +

+READ_ONLY

+public static final UserClass READ_ONLY

+ + +

+ +

+READ_WRITE

+public static final UserClass READ_WRITE

+ + + + + + + + + + +

+Field Detail

+ +

+configName

+public java.lang.String configName

The name of the tag in the configuration file that contains the + credentials for this user class. +

+ +

+ + + + + + + + +

+Method Detail

+ +

+values

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

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

+ +

+valueOf

+public static UserClass valueOf(java.lang.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: +: java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +; java.lang.NullPointerException - if the argument is null

+ +