Skip to content

Commit 66063cd

Browse files
committed
Rebased ChannelStorageManager to a record, along with adding JavaDoc to the record.
1 parent 1191558 commit 66063cd

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

src/main/java/com/jacrispys/JavaBot/Utils/ChannelStorageManager.java

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ private InputStream loadConfig() {
3232
* @return true if the guild was successfully added,
3333
* will {@return} false if the guild was already located in the data file
3434
*/
35+
@SuppressWarnings("all")
3536
public boolean addNewGuild(Guild guild) {
3637
try {
3738
Map<Long, Map<String, Long>> guildList = this.yaml.load(loadConfig());
@@ -54,6 +55,13 @@ public boolean addNewGuild(Guild guild) {
5455
}
5556
}
5657

58+
/**
59+
*
60+
* @param guild to have ticket channel set
61+
* @param channel {@link TextChannel} where tickets will be collected
62+
* @return {@link Boolean} is true if the guild has no ticket channel & throws no errors, false otherwise
63+
*/
64+
@SuppressWarnings("all")
5765
public boolean setTicketChannel(Guild guild, TextChannel channel) {
5866
try {
5967
Map<Long, Map<String, Long>> guildList = this.yaml.load(loadConfig());
@@ -75,6 +83,13 @@ public boolean setTicketChannel(Guild guild, TextChannel channel) {
7583
}
7684
}
7785

86+
/**
87+
*
88+
* @param guild to be found in data file
89+
* @param dataTag is the name of the data to be added
90+
* @param data the actual data being changed
91+
*/
92+
@SuppressWarnings("all")
7893
public void addGuildData(Guild guild, String dataTag, Object data) {
7994
try {
8095
Map<Long, Map<String, Object>> guildList = this.yaml.load(loadConfig());
@@ -94,6 +109,13 @@ public void addGuildData(Guild guild, String dataTag, Object data) {
94109
}
95110
}
96111

112+
/**
113+
*
114+
* @param guild to be found in data file
115+
* @param dataTag is the name of the data to be added
116+
* @param data the actual data being changed
117+
*/
118+
@SuppressWarnings("all")
97119
public void setGuildData(Guild guild, String dataTag, Object data) {
98120
try {
99121
Map<Long, Map<String, Object>> guildList = this.yaml.load(loadConfig());
@@ -113,6 +135,13 @@ public void setGuildData(Guild guild, String dataTag, Object data) {
113135
}
114136
}
115137

138+
/**
139+
*
140+
* @param guild is the guild to obtain data from
141+
* @param dataTag name of the data location
142+
* @return object of what is inside the {@param dataTag}
143+
* @throws NullPointerException if the queried data could not be found
144+
*/
116145
public Object getGuildData(Guild guild, String dataTag) throws NullPointerException {
117146
try {
118147
InputStream is;

0 commit comments

Comments
 (0)