Add some commenting

This commit is contained in:
ElgarL 2012-02-05 16:41:34 +00:00
parent e93e50f6d2
commit 97bd49e598
4 changed files with 12 additions and 36 deletions

View file

@ -67,7 +67,7 @@ public abstract class DataUnit {
} }
/** /**
* Set the data source to point to a new worldDataHolder * Set the data source to point to a different worldDataHolder
* *
* @param source * @param source
*/ */
@ -76,6 +76,8 @@ public abstract class DataUnit {
} }
/** /**
* Get the current worldDataHolder this object is pointing to
*
* @return the dataSource * @return the dataSource
*/ */
public WorldDataHolder getDataSource() { public WorldDataHolder getDataSource() {

View file

@ -9,15 +9,13 @@ import org.anjocaido.groupmanager.data.Group;
/** /**
* This container holds all Groups loaded from the relevant groupsFile.
*
* @author ElgarL * @author ElgarL
* *
*/ */
public class GroupsDataHolder { public class GroupsDataHolder {
/**
* Root World name this set of groups is associated with.
*/
//private String name;
private WorldDataHolder dataSource; private WorldDataHolder dataSource;
private Group defaultGroup = null; private Group defaultGroup = null;
private File groupsFile; private File groupsFile;
@ -42,17 +40,6 @@ public class GroupsDataHolder {
group.setDataSource(this.dataSource); group.setDataSource(this.dataSource);
} }
//protected void setWorldName(String worldName) {
// name = worldName;
//}
/**
* @return the name
*/
//public String getWorldName() {
// return name;
//}
/** /**
* @return the defaultGroup * @return the defaultGroup
*/ */

View file

@ -9,15 +9,13 @@ import org.anjocaido.groupmanager.data.User;
/** /**
* This container holds all Users loaded from the relevant usersFile.
*
* @author ElgarL * @author ElgarL
* *
*/ */
public class UsersDataHolder { public class UsersDataHolder {
/**
* Root World name this set of groups is associated with.
*/
//private String name;
private WorldDataHolder dataSource; private WorldDataHolder dataSource;
private File usersFile; private File usersFile;
private boolean haveUsersChanged = false; private boolean haveUsersChanged = false;
@ -42,20 +40,6 @@ public class UsersDataHolder {
} }
/**
* @param worldName
*/
//public void setWorldName(String worldName) {
// this.name = worldName;
//}
/**
* @return the name
*/
//public String getWorldName() {
// return this.name;
//}
/** /**
* @return the users * @return the users
*/ */

View file

@ -36,8 +36,11 @@ import org.yaml.snakeyaml.constructor.SafeConstructor;
import org.yaml.snakeyaml.reader.UnicodeReader; import org.yaml.snakeyaml.reader.UnicodeReader;
/** /**
* * One instance of this should exist per world/mirror
* @author gabrielcouto * it contains all functions to manage these data sets
* and points to the relevant users and groups objects.
*
* @author gabrielcouto, ElgarL
*/ */
public class WorldDataHolder { public class WorldDataHolder {