zdm/envoy
zdm/envoy
Archived
3
Fork 0
Code Issues 22 Pull Requests Releases 1 Wiki Activity

Fixed Javadoc formatting and spelling

Browse Source
This commit is contained in:
Kai S. K. Engelbart 2019-10-30 17:01:55 +01:00
parent 043219135f
commit f1b6869945
2 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/main/java/envoy/client/Config.java
View File

@ -52,58 +52,57 @@ public class Config {
case "--localDB": case "--localDB":
case "-db": case "-db":
localDB = new File(args[++i]); localDB = new File(args[++i]);
break;
} }
} }
/** /**
* @return {@code true} if server, port andd localDB directory are known. * @return {@code true} if server, port and localDB directory are known.
* @since Envoy v0.1-alpha * @since Envoy v0.1-alpha
*/ */
public boolean isInitialized() { return server != null && !server.isEmpty() && port > 0 && port < 65566 && localDB != null; } public boolean isInitialized() { return server != null && !server.isEmpty() && port > 0 && port < 65566 && localDB != null; }
/** /**
* @return the URL of our website * @return the host name of the Envoy server
* @since Envoy v0.1-alpha * @since Envoy v0.1-alpha
*/ */
public String getServer() { return server; } public String getServer() { return server; }
/** /**
* Changes the default URL. * Changes the default server host name.
* Exclusively meant for developing reasons. (localhost) * Exclusively intended for development purposes.
* *
* @param server the URL where wish to host Envoy * @param server the host name of the Envoy server
* @since Envoy v0.1-alpha * @since Envoy v0.1-alpha
*/ */
public void setServer(String server) { this.server = server; } public void setServer(String server) { this.server = server; }
/** /**
* @return the port at which Envoy is located in the Server * @return the port at which the Envoy server is located on the host
* @since Envoy v0.1-alpha * @since Envoy v0.1-alpha
*/ */
public int getPort() { return port; } public int getPort() { return port; }
/** /**
* Changes the default port. * Changes the default port.
* Exclusively meant for developing reasons. (localhost) * Exclusively intended for development purposes.
* *
* @param port the port where we wish to connect to {@code Envoy}. * @param port the port where an Envoy server is located
* @since Envoy v0.1-alpha * @since Envoy v0.1-alpha
*/ */
public void setPort(int port) { this.port = port; } public void setPort(int port) { this.port = port; }
/** /**
*@return the current local database that is held for that user * @return the local database specific to the client user
*@since Envoy v0.1-alpha * @since Envoy v0.1-alpha
**/ **/
public File getLocalDB() { return localDB; } public File getLocalDB() { return localDB; }
/** /**
*Changes the default local database. * Changes the default local database.
*Exclusively meant for developing reasons. * Exclusively intended for development purposes.
* *
*@param the local database object to set * @param the file containing the local database
*@since Envoy v0.1-alpha * @since Envoy v0.1-alpha
**/ **/
public void setLocalDB(File localDB) { this.localDB = localDB; } public void setLocalDB(File localDB) { this.localDB = localDB; }
} }

33
src/main/java/envoy/client/LocalDB.java
View File

@ -27,20 +27,20 @@ public class LocalDB {
private List<Chat> chats = new ArrayList<>(); private List<Chat> chats = new ArrayList<>();
/** /**
*Constructs an empty local database. * Constructs an empty local database.
* *
*@param sender the user who logs in * @param sender the user that is logged in with this client
*@since Envoy v0.1-alpha * @since Envoy v0.1-alpha
**/ **/
public LocalDB(User sender) { this.sender = sender; } public LocalDB(User sender) { this.sender = sender; }
/** /**
*Initialises the local database and fills it with values * Initializes the local database and fills it with values
*if the user already sent/ received a message.<br> * if the user has already sent or received messages.
* *
*@param localDBDir the directory where we wish to save/load the database from. * @param localDBDir the directory where we wish to save/load the database from.
*@throws EnvoyException if the directory selected is not an actual directory. * @throws EnvoyException if the directory selected is not an actual directory.
*@since Envoy v0.1-alpha * @since Envoy v0.1-alpha
**/ **/
public void initializeDBFile(File localDBDir) throws EnvoyException { public void initializeDBFile(File localDBDir) throws EnvoyException {
if (localDBDir.exists() && !localDBDir.isDirectory()) if (localDBDir.exists() && !localDBDir.isDirectory())
@ -50,10 +50,10 @@ public class LocalDB {
} }
/** /**
*Saves the database into a file for future use. * Saves the database into a file for future use.
* *
*@throws IOException if something went wrong during saving * @throws IOException if something went wrong during saving
*@since Envoy v0.1-alpha * @since Envoy v0.1-alpha
**/ **/
public void saveToLocalDB() { public void saveToLocalDB() {
try { try {
@ -72,10 +72,10 @@ public class LocalDB {
} }
/** /**
*Loads all chats saved by Envoy for the user.<br> * Loads all chats saved by Envoy for the client user.
* *
*@throws EnvoyException if something fails while loading. * @throws EnvoyException if something fails while loading.
*@since Envoy v0.1-alpha * @since Envoy v0.1-alpha
**/ **/
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
private void loadFromLocalDB() throws EnvoyException { private void loadFromLocalDB() throws EnvoyException {
@ -88,8 +88,9 @@ public class LocalDB {
} }
/** /**
*@return all chats that the user has saved * @return all saves {@link Chat} objects that list the client user as the
*@since Envoy v0.1-alpha * sender
* @since Envoy v0.1-alpha
**/ **/
public List<Chat> getChats() { return chats; } public List<Chat> getChats() { return chats; }
} }