Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Commit a512a2b

Browse files
committed
Add comment to the deserialize method of Serializable about exception throwing
1 parent 13dd701 commit a512a2b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/main/java/org/codeoverflow/chatoverflow/api/io/Serializable.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ public interface Serializable {
88
/**
99
* Serializes this object into a string to save it to a config
1010
*
11-
* @return serialized
11+
* @return serialized data
1212
*/
1313
String serialize();
1414

1515
/**
1616
* Deserialize a string to apply provided config settings to this object
17+
* If the string can't be deserialized this method should thrown an exception
1718
*
18-
* @param value should be serialized
19+
* @param value the string that should be deserialized
1920
*/
2021
void deserialize(String value);
2122
}

0 commit comments

Comments
 (0)