added documentation

This commit is contained in:
paul-loedige 2021-01-07 19:24:07 +01:00
parent c94331eeaf
commit 0faf25f00b

View File

@ -117,13 +117,20 @@ public class ConfigurationHandler implements IFAVORITES {
return deviceName; return deviceName;
} }
//cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc /**
* Method to get the name of the current view.
* @return the name of the current view
*/
public String getCurrentView() { public String getCurrentView() {
return configurations.getCurrentView(); return configurations.getCurrentView();
} }
//cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc /**
public String setCurrentView(String viewName) { * Method to set the name of the current view.
* @param viewName the name to be set
* @return the name that has been set
*/
public String setCurrentView(final String viewName) {
configurations.setCurrentView(viewName); configurations.setCurrentView(viewName);
writeJsonFile(); writeJsonFile();
return getCurrentView(); return getCurrentView();
@ -205,14 +212,20 @@ public class ConfigurationHandler implements IFAVORITES {
/** The names of the favorite devices. **/ /** The names of the favorite devices. **/
private List<String> favoriteNames = new ArrayList<>(); private List<String> favoriteNames = new ArrayList<>();
//cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc /**
* Getter for currentView.
* @return the name of the current view
*/
public String getCurrentView() { public String getCurrentView() {
return currentView; return currentView;
} }
//cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc /**
public void setCurrentView(String currentView) { * Setter for currentView.
this.currentView = currentView; * @param pCurrentView the name of the current view
*/
public void setCurrentView(final String pCurrentView) {
this.currentView = pCurrentView;
} }
/** The name of the current view. **/ /** The name of the current view. **/