Skip to content
Snippets Groups Projects
Commit bfd3cd1c authored by Tobias Ullerich's avatar Tobias Ullerich
Browse files

Fix javadoc comments in PlayWallCore

parent 0dff5a9f
No related branches found
No related tags found
No related merge requests found
......@@ -9,6 +9,7 @@ import de.tobias.playpad.plugin.SettingsListener;
import de.tobias.playpad.profile.ProfileNotFoundException;
import de.tobias.playpad.project.Project;
import de.tobias.playpad.project.ProjectNotFoundException;
import de.tobias.playpad.project.ProjectReader;
import de.tobias.playpad.project.ProjectReader.ProjectReaderDelegate.ProfileAbortException;
import de.tobias.playpad.project.ref.ProjectReference;
import de.tobias.playpad.settings.GlobalSettings;
......@@ -127,6 +128,11 @@ public interface PlayPad {
*
* @param projectReference project reference
* @param onLoaded on project loaded callback
* @throws IOException io error
* @throws ProjectNotFoundException Project to solve error not found
* @throws ProfileNotFoundException Profile of project not found
* @throws DocumentException XML Error
* @throws ProjectReader.ProjectReaderDelegate.ProfileAbortException Profile Choose aborted
*/
void openProject(ProjectReference projectReference, Consumer<NVC> onLoaded) throws ProjectNotFoundException, ProfileAbortException, ProfileNotFoundException, DocumentException, IOException;
......
......@@ -15,6 +15,7 @@ public interface ActionFeedbackSuggester {
/**
* Is automatic feedback suggestion enabled
*
* @param action action
* @return <code>true</code> Active
*/
boolean isAutoFeedbackColors(Action action);
......
......@@ -687,7 +687,7 @@ public class Pad {
/**
* Returns true, when pad has content and pad is visible.
*
* @return loaded & visible
* @return loaded &amp; visible
*/
public boolean hasVisibleContent() {
return getContent() != null && getContent().isPadLoaded() && isPadVisible();
......
......@@ -230,6 +230,7 @@ public class Page {
* Removes a pad from a page and from the cloud.
*
* @param uuid id of the pad
* @param deleteRemote <code>true</code> delete from remote
*/
public void removePad(UUID uuid, boolean deleteRemote) {
if (projectReference.getProjectReference().isSync() && deleteRemote) {
......
......@@ -59,6 +59,8 @@ public interface Server {
* @param username username
* @param password password
* @return session key
* @throws IOException server communication error
* @throws LoginException login error
*/
String getSession(String username, String password) throws IOException, LoginException;
......@@ -69,6 +71,7 @@ public interface Server {
*
* @return synced projects
* @throws IOException notwork error
* @throws LoginException login error
*/
List<ProjectReference> getSyncedProjects() throws IOException, LoginException;
......@@ -94,6 +97,7 @@ public interface Server {
*
* @param projectReference project reference
* @return last modification
* @throws IOException server communication error
*/
Version getLastServerModification(ProjectReference projectReference) throws IOException;
......@@ -101,6 +105,8 @@ public interface Server {
* Connect to sync server with key.
*
* @param key auth key
* @throws IOException server communication error
* @throws WebSocketException error creating websocket connection
*/
void connect(String key) throws IOException, WebSocketException;
......
......@@ -11,6 +11,7 @@ public interface Command {
* Execute a command.
*
* @param data optional data parameter
* @return response to communication peer
*/
JsonObject execute(Object data);
}
......@@ -21,6 +21,11 @@ public interface ConflictSolver {
* @param executor command executor
* @param project project
* @param type strategy type
* @throws IOException server communication error
* @throws ProjectNotFoundException Project to solve error not found
* @throws ProfileNotFoundException Profile of project not found
* @throws DocumentException XML Error
* @throws ProjectReader.ProjectReaderDelegate.ProfileAbortException Profile Choose aborted
*/
void solveConflict(CommandExecutor executor, ProjectReference project, ConflictStrategyType type) throws ProjectNotFoundException, ProfileNotFoundException, DocumentException, IOException, ProjectReader.ProjectReaderDelegate.ProfileAbortException;
......@@ -30,6 +35,7 @@ public interface ConflictSolver {
* @param executor command executor
* @param reference project reference
* @return conflict type
* @throws IOException server communication error
*/
ConflictType checkConflict(CommandExecutor executor, ProjectReference reference) throws IOException;
......@@ -38,6 +44,7 @@ public interface ConflictSolver {
*
* @param reference project reference
* @return list of versions
* @throws IOException server communication error
*/
List<Version> getVersions(ProjectReference reference) throws IOException;
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment