diff options
| author | ElgarL <ElgarL@palmergames.com> | 2012-02-05 16:41:34 +0000 |
|---|---|---|
| committer | ElgarL <ElgarL@palmergames.com> | 2012-02-05 16:41:34 +0000 |
| commit | 97bd49e598ddb4725a19788098158c7bf9f1a55f (patch) | |
| tree | 0ae29c8983b6e98be01e2b503baf78d3de4bde0e /EssentialsGroupManager | |
| parent | e93e50f6d273b940783e7c313610f4cfa7ed15e2 (diff) | |
| download | Essentials-97bd49e598ddb4725a19788098158c7bf9f1a55f.tar Essentials-97bd49e598ddb4725a19788098158c7bf9f1a55f.tar.gz Essentials-97bd49e598ddb4725a19788098158c7bf9f1a55f.tar.lz Essentials-97bd49e598ddb4725a19788098158c7bf9f1a55f.tar.xz Essentials-97bd49e598ddb4725a19788098158c7bf9f1a55f.zip | |
Add some commenting
Diffstat (limited to 'EssentialsGroupManager')
4 files changed, 12 insertions, 36 deletions
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java index 03d31b848..e3250a1c1 100644 --- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java +++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java @@ -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 */ @@ -76,6 +76,8 @@ public abstract class DataUnit { } /** + * Get the current worldDataHolder this object is pointing to + * * @return the dataSource */ public WorldDataHolder getDataSource() { diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java index 444939251..5d681013e 100644 --- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java +++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java @@ -9,15 +9,13 @@ import org.anjocaido.groupmanager.data.Group; /**
+ * This container holds all Groups loaded from the relevant groupsFile.
+ *
* @author ElgarL
*
*/
public class GroupsDataHolder {
- /**
- * Root World name this set of groups is associated with.
- */
- //private String name;
private WorldDataHolder dataSource;
private Group defaultGroup = null;
private File groupsFile;
@@ -42,17 +40,6 @@ public class GroupsDataHolder { group.setDataSource(this.dataSource);
}
- //protected void setWorldName(String worldName) {
- // name = worldName;
- //}
-
- /**
- * @return the name
- */
- //public String getWorldName() {
- // return name;
- //}
-
/**
* @return the defaultGroup
*/
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java index 1d7bbb704..fa2ccaf84 100644 --- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java +++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java @@ -9,15 +9,13 @@ import org.anjocaido.groupmanager.data.User; /**
+ * This container holds all Users loaded from the relevant usersFile.
+ *
* @author ElgarL
*
*/
public class UsersDataHolder {
- /**
- * Root World name this set of groups is associated with.
- */
- //private String name;
private WorldDataHolder dataSource;
private File usersFile;
private boolean haveUsersChanged = false;
@@ -43,20 +41,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
*/
public Map<String, User> getUsers() {
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java index 69305f360..8115b1a75 100644 --- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java +++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java @@ -36,8 +36,11 @@ import org.yaml.snakeyaml.constructor.SafeConstructor; import org.yaml.snakeyaml.reader.UnicodeReader; /** - * - * @author gabrielcouto + * One instance of this should exist per world/mirror + * it contains all functions to manage these data sets + * and points to the relevant users and groups objects. + * + * @author gabrielcouto, ElgarL */ public class WorldDataHolder { |