From 2d073129857a42ab4195cd433c8be152e357033f Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 20:40:57 +0000 Subject: Documentation refresh; ResourceBundle in ShowUtils; probably some format pokery. --- src/uk/org/ury/database/UserClass.java | 46 ++++++++++++++++------------------ 1 file changed, 22 insertions(+), 24 deletions(-) (limited to 'src/uk/org/ury/database/UserClass.java') diff --git a/src/uk/org/ury/database/UserClass.java b/src/uk/org/ury/database/UserClass.java index 79af61a..48cb2d3 100644 --- a/src/uk/org/ury/database/UserClass.java +++ b/src/uk/org/ury/database/UserClass.java @@ -3,38 +3,36 @@ */ package uk.org.ury.database; - /** * 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. + * 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. * - * Please use the least privileged user class that works. For most - * cases, READ_ONLY should work perfectly. + * @author Matt Windsor * - * @author Matt Windsor - * */ -public enum UserClass - { - // Constant configName - READ_ONLY ("read_only"), - READ_WRITE ("read_write"); - - +public enum UserClass { + // Constant configName + READ_ONLY ("read_only"), + READ_WRITE ("read_write"); + /** - * The name of the tag in the configuration file that contains - * the credentials for this user class. + * The name of the tag in the configuration file that contains the + * credentials for this user class. */ - public String configName; - - - private - UserClass (String configName) - { - this.configName = configName; + + /** + * Constructs a new UserClass. + * + * @param configName The name of the user class in the config. + */ + private UserClass(String configName) { + this.configName = configName; } - } +} -- cgit v1.2.3