checkstyle rules
authordarisk@kaaliyah
Mon, 10 Aug 2009 06:46:02 +0200
changeset 348 bf5fcec4bbfc
parent 347 0788f198e848
child 349 84d45a88699f
checkstyle rules
src/com/beem/project/beem/ui/EditSettings.java
--- a/src/com/beem/project/beem/ui/EditSettings.java	Mon Aug 10 06:29:46 2009 +0200
+++ b/src/com/beem/project/beem/ui/EditSettings.java	Mon Aug 10 06:46:02 2009 +0200
@@ -28,37 +28,37 @@
  */
 public class EditSettings extends Activity {
 
-    private final static String LOG_MSG_SETTINGS_SAVED = "Settings saved successfully.";
-    private final static String LOG_MSG_XMPP_SETTINGS_REGISTERED = "XMPP Settings has been registered.";
-    private final static String LOG_MSG_ACCOUNT_SETTINGS_REGISTERED = "Account Settings has been registered.";
-    private final static String LOG_MSG_PROXY_SETTINGS_REGISTERED = "Proxy Settings has been registered.";
+    private static final String LOG_MSG_SETTINGS_SAVED = "Settings saved successfully.";
+    private static final String LOG_MSG_XMPP_SETTINGS_REGISTERED = "XMPP Settings has been registered.";
+    private static final String LOG_MSG_ACCOUNT_SETTINGS_REGISTERED = "Account Settings has been registered.";
+    private static final String LOG_MSG_PROXY_SETTINGS_REGISTERED = "Proxy Settings has been registered.";
 
-    private final static boolean DEFAULT_BOOLEAN_VALUE = false;
-    private final static String DEFAULT_STRING_VALUE = "";
-    private final static int DEFAULT_INT_VALUE = 0;
+    private static final boolean DEFAULT_BOOLEAN_VALUE = false;
+    private static final String DEFAULT_STRING_VALUE = "";
+    private static final int DEFAULT_INT_VALUE = 0;
 
-    private final static String DEFAULT_XMPP_PORT = "5222";
+    private static final String DEFAULT_XMPP_PORT = "5222";
 
-    private final static int NOTIFICATION_DURATION = Toast.LENGTH_SHORT;
+    private static final int NOTIFICATION_DURATION = Toast.LENGTH_SHORT;
 
-    private SharedPreferences mSettings = null;
+    private SharedPreferences mSettings;
 
-    private EditText mAccUsernameField = null;
-    private EditText mAccPasswordField = null;
+    private EditText mAccUsernameField;
+    private EditText mAccPasswordField;
 
-    private EditText mXmppServerField = null;
-    private EditText mXmppPortField = null;
-    private CheckBox mXmppUseTlsCheckBox = null;
+    private EditText mXmppServerField;
+    private EditText mXmppPortField;
+    private CheckBox mXmppUseTlsCheckBox;
 
-    private CheckBox mProxyUseCheckBox = null;
-    private Spinner mProxyTypeSpinner = null;
-    private EditText mProxyServerField = null;
-    private EditText mProxyPortField = null;
-    private EditText mProxyUsernameField = null;
-    private EditText mProxyPasswordField = null;
+    private CheckBox mProxyUseCheckBox;
+    private Spinner mProxyTypeSpinner;
+    private EditText mProxyServerField;
+    private EditText mProxyPortField;
+    private EditText mProxyUsernameField;
+    private EditText mProxyPasswordField;
 
     /**
-     * Add a labeled "Account" tab on the tabbed window view passed by parameter
+     * Add a labeled "Account" tab on the tabbed window view passed by parameter.
      * @param tHost a tabbed window view
      */
     private void addAccountTab(TabHost tHost) {
@@ -69,7 +69,7 @@
     }
 
     /**
-     * Add a labeled "Proxy" tab on the tabbed window view passed by parameter
+     * Add a labeled "Proxy" tab on the tabbed window view passed by parameter.
      * @param tHost a tabbed window view
      */
     private void addProxyTab(TabHost tHost) {
@@ -80,7 +80,7 @@
     }
 
     /**
-     * Add a labeled "XMPP" tab on the tabbed window view passed by parameter
+     * Add a labeled "XMPP" tab on the tabbed window view passed by parameter.
      * @param tHost a tabbed window view
      */
     private void addXMPPTab(TabHost tHost) {
@@ -91,7 +91,7 @@
     }
 
     /**
-     * Disable proxy parameters fields
+     * Disable proxy parameters fields.
      */
     private void disableProxyParameters() {
 	mProxyTypeSpinner.setEnabled(false);
@@ -111,13 +111,16 @@
 	mProxyPasswordField.setFocusableInTouchMode(false);
     }
 
+    /**
+     * Display a brief notification.
+     */
     private void displayNotification(CharSequence msg) {
 	Toast toast = Toast.makeText(getApplicationContext(), msg, NOTIFICATION_DURATION);
 	toast.show();
     }
 
     /**
-     * Enable proxy parameters fields
+     * Enable proxy parameters fields.
      */
     private void enableProxyParameters() {
 	mProxyTypeSpinner.setEnabled(true);
@@ -138,107 +141,107 @@
     }
 
     /**
-     * Retrieve the value of a CheckBox
-     * @param viewId
+     * Retrieve the value of a CheckBox.
+     * @param viewId identifier of the checkbox
      * @return true if the CheckBox is checked, else false
      */
     private boolean getCheckBoxValue(int viewId) {
 	final CheckBox checkBox = (CheckBox) findViewById(viewId);
 	if (checkBox.isChecked())
-	    return (true);
-	return (false);
+	    return true;
+	return false;
     }
 
     /**
-     * Retrieve account password from the preferences
+     * Retrieve account password from the preferences.
      * @return Registered account password
      */
     private String getRegisteredAccountPassword() {
-	return (mSettings.getString(getString(R.string.settings_key_account_password), DEFAULT_STRING_VALUE));
+	return mSettings.getString(getString(R.string.settings_key_account_password), DEFAULT_STRING_VALUE);
     }
 
     /**
-     * Retrieve account username from the preferences
+     * Retrieve account username from the preferences.
      * @return Registered account username
      */
     private String getRegisteredAccountUsername() {
-	return (mSettings.getString(getString(R.string.settings_key_account_username), DEFAULT_STRING_VALUE));
+	return mSettings.getString(getString(R.string.settings_key_account_username), DEFAULT_STRING_VALUE);
     }
 
     /**
-     * Retrieve proxy password from the preferences
+     * Retrieve proxy password from the preferences.
      * @return Registered proxy password
      */
     private String getRegisteredProxyPassword() {
-	return (mSettings.getString(getString(R.string.settings_key_proxy_password), DEFAULT_STRING_VALUE));
+	return mSettings.getString(getString(R.string.settings_key_proxy_password), DEFAULT_STRING_VALUE);
     }
 
     /**
-     * Retrieve proxy port from the preferences
+     * Retrieve proxy port from the preferences.
      * @return Registered proxy port
      */
     private String getRegisteredProxyPort() {
-	return (mSettings.getString(getString(R.string.settings_key_proxy_port), DEFAULT_STRING_VALUE));
+	return mSettings.getString(getString(R.string.settings_key_proxy_port), DEFAULT_STRING_VALUE);
     }
 
     /**
-     * Retrieve proxy server from the preferences
+     * Retrieve proxy server from the preferences.
      * @return Registered proxy server
      */
     private String getRegisteredProxyServer() {
-	return (mSettings.getString(getString(R.string.settings_key_proxy_server), DEFAULT_STRING_VALUE));
+	return mSettings.getString(getString(R.string.settings_key_proxy_server), DEFAULT_STRING_VALUE);
     }
 
     /**
-     * Retrieve proxy type from the preferences
+     * Retrieve proxy type from the preferences.
      * @return Registered proxy type
      */
     private int getRegisteredProxyType() {
-	return (mSettings.getInt(getString(R.string.settings_key_proxy_type), DEFAULT_INT_VALUE));
+	return mSettings.getInt(getString(R.string.settings_key_proxy_type), DEFAULT_INT_VALUE);
     }
 
     /**
-     * Retrieve proxy use from the preferences
+     * Retrieve proxy use from the preferences.
      * @return Registered proxy use
      */
     private boolean getRegisteredProxyUse() {
-	return (mSettings.getBoolean(getString(R.string.settings_key_proxy_use), DEFAULT_BOOLEAN_VALUE));
+	return mSettings.getBoolean(getString(R.string.settings_key_proxy_use), DEFAULT_BOOLEAN_VALUE);
     }
 
     /**
-     * Retrieve proxy username from the preferences
+     * Retrieve proxy username from the preferences.
      * @return Registered proxy username
      */
     private String getRegisteredProxyUsername() {
-	return (mSettings.getString(getString(R.string.settings_key_proxy_username), DEFAULT_STRING_VALUE));
+	return mSettings.getString(getString(R.string.settings_key_proxy_username), DEFAULT_STRING_VALUE);
     }
 
     /**
-     * Retrieve xmpp port from the preferences
+     * Retrieve xmpp port from the preferences.
      * @return Registered xmpp port
      */
     private String getRegisteredXMPPPort() {
-	return (mSettings.getString(getString(R.string.settings_key_xmpp_port), DEFAULT_XMPP_PORT));
+	return mSettings.getString(getString(R.string.settings_key_xmpp_port), DEFAULT_XMPP_PORT);
     }
 
     /**
-     * Retrieve xmpp server from the preferences
+     * Retrieve xmpp server from the preferences.
      * @return Registered xmpp server
      */
     private String getRegisteredXMPPServer() {
-	return (mSettings.getString(getString(R.string.settings_key_xmpp_server), DEFAULT_STRING_VALUE));
+	return mSettings.getString(getString(R.string.settings_key_xmpp_server), DEFAULT_STRING_VALUE);
     }
 
     /**
-     * Retrieve TLS use from the preferences
+     * Retrieve TLS use from the preferences.
      * @return Registered TLS use
      */
     private boolean getRegisteredXMPPTLSUse() {
-	return (mSettings.getBoolean(getString(R.string.settings_key_xmpp_tls_use), DEFAULT_BOOLEAN_VALUE));
+	return mSettings.getBoolean(getString(R.string.settings_key_xmpp_tls_use), DEFAULT_BOOLEAN_VALUE);
     }
 
     /**
-     * Initialize Account tab fields
+     * Initialize Account tab fields.
      */
     private void initAccountFields() {
 	mAccUsernameField = (EditText) findViewById(R.id.settings_account_username);
@@ -246,7 +249,7 @@
     }
 
     /**
-     * Initialize all of the components displayed in tabs (EditText fields, CheckBoxes, Spinners...)
+     * Initialize all of the components displayed in tabs (EditText fields, CheckBoxes, Spinners...).
      */
     private void initFields() {
 	initAccountFields();
@@ -255,7 +258,7 @@
     }
 
     /**
-     * Initialize Proxy tab fields
+     * Initialize Proxy tab fields.
      */
     private void initProxyFields() {
 	mProxyUseCheckBox = (CheckBox) findViewById(R.id.settings_proxy_use);
@@ -267,7 +270,7 @@
     }
 
     /**
-     * Initialize proxy's types spinner of the proxy tab
+     * Initialize proxy's types spinner of the proxy tab.
      */
     private void initProxyTypesSpinner() {
 	ArrayAdapter<CharSequence> adapter = ArrayAdapter.createFromResource(this, R.array.proxy_types,
@@ -277,7 +280,7 @@
     }
 
     /**
-     * Initialize the checkbox allowing user to use a proxy
+     * Initialize the checkbox allowing user to use a proxy.
      */
     private void initProxyUseCheckBox() {
 	mProxyUseCheckBox.setOnClickListener(new OnClickListener() {
@@ -293,7 +296,7 @@
     }
 
     /**
-     * Initialize "save" buttons allowing user to save settings
+     * Initialize "save" buttons allowing user to save settings.
      */
     private void initSaveButtons() {
 	final ArrayList<Integer> views = new ArrayList<Integer>();
@@ -317,7 +320,7 @@
     }
 
     /**
-     * Initialize tabbed window view by adding tabs and setting the default tab
+     * Initialize tabbed window view by adding tabs and setting the default tab.
      */
     private void initTabbedWindow() {
 	TabHost tHost = (TabHost) this.findViewById(R.id.settings_tab_host);
@@ -329,7 +332,7 @@
     }
 
     /**
-     * Initialize XMPP tab fields
+     * Initialize XMPP tab fields.
      */
     private void initXMPPFields() {
 	mXmppServerField = (EditText) findViewById(R.id.settings_xmpp_server);
@@ -366,15 +369,16 @@
     public boolean onOptionsItemSelected(MenuItem item) {
 	Intent i = null;
 	switch (item.getItemId()) {
-	case R.id.settings_menu_create_account:
-	    i = new Intent(this, CreateAccount.class);
-	    startActivity(i);
-	    return true;
-	case R.id.settings_menu_login:
-	    finish();
-	    return true;
+	    case R.id.settings_menu_create_account:
+		i = new Intent(this, CreateAccount.class);
+		startActivity(i);
+		return true;
+	    case R.id.settings_menu_login:
+		finish();
+		return true;
+	    default:
+		return false;
 	}
-	return false;
     }
 
     /**
@@ -403,7 +407,7 @@
     }
 
     /**
-     * Refresh values of "Account" tab fields
+     * Refresh values of "Account" tab fields.
      */
     private void refreshAccountTabFields() {
 	mAccUsernameField.setText(getRegisteredAccountUsername());
@@ -411,7 +415,7 @@
     }
 
     /**
-     * Refresh values of "Account" tab fields
+     * Refresh values of "Account" tab fields.
      */
     private void refreshProxyTabFields() {
 	mProxyUseCheckBox.setChecked(getRegisteredProxyUse());
@@ -423,7 +427,7 @@
     }
 
     /**
-     * Refresh values of "Account" tab fields
+     * Refresh values of "Account" tab fields.
      */
     private void refreshXMPPTabFields() {
 	mXmppServerField.setText(getRegisteredXMPPServer());
@@ -432,23 +436,23 @@
     }
 
     /**
-     * Register account settings changes in SharedPreferences.Editor object passed by parameter
-     * @param settingsEditor
+     * Register account settings changes in SharedPreferences.Editor object passed by parameter.
+     * @param settingsEditor the editor to use.
      */
     private void registerAccountSettingsChanges(SharedPreferences.Editor settingsEditor) {
 	final String usernameFieldValue = mAccUsernameField.getText().toString();
 	final String passwordFieldValue = mAccPasswordField.getText().toString();
 
-	if (getRegisteredAccountUsername().equals(usernameFieldValue) == false)
+	if (!getRegisteredAccountUsername().equals(usernameFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_account_username), usernameFieldValue);
-	if (getRegisteredAccountPassword().equals(passwordFieldValue) == false)
+	if (!getRegisteredAccountPassword().equals(passwordFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_account_password), passwordFieldValue);
 	Log.i(getString(R.string.edit_settings_tag), LOG_MSG_ACCOUNT_SETTINGS_REGISTERED);
     }
 
     /**
-     * Register proxy settings changes in SharedPreferences.Editor object passed by parameter
-     * @param settingsEditor
+     * Register proxy settings changes in SharedPreferences.Editor object passed by parameter.
+     * @param settingsEditor the editor to use.
      */
     private void registerProxySettingsChanges(SharedPreferences.Editor settingsEditor) {
 	final int proxyTypeFieldValue = mProxyTypeSpinner.getSelectedItemPosition();
@@ -459,20 +463,20 @@
 
 	if (getRegisteredProxyType() != proxyTypeFieldValue)
 	    settingsEditor.putInt(getString(R.string.settings_key_proxy_type), proxyTypeFieldValue);
-	if (getRegisteredProxyServer().equals(serverFieldValue) == false)
+	if (!getRegisteredProxyServer().equals(serverFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_proxy_server), serverFieldValue);
-	if (getRegisteredProxyPort().equals(portFieldValue) == false)
+	if (!getRegisteredProxyPort().equals(portFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_proxy_port), portFieldValue);
-	if (getRegisteredProxyUsername().equals(usernameFieldValue) == false)
+	if (!getRegisteredProxyUsername().equals(usernameFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_proxy_username), usernameFieldValue);
-	if (getRegisteredProxyPassword().equals(passwordFieldValue) == false)
+	if (!getRegisteredProxyPassword().equals(passwordFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_proxy_password), passwordFieldValue);
 	Log.i(getString(R.string.edit_settings_tag), LOG_MSG_PROXY_SETTINGS_REGISTERED);
     }
 
     /**
-     * Register XMPP settings changes in SharedPreferences.Editor object passed by parameter
-     * @param settingsEditor
+     * Register XMPP settings changes in SharedPreferences.Editor object passed by parameter.
+     * @param settingsEditor the editor to use.
      */
     private void registerXMPPSettingsChanges(SharedPreferences.Editor settingsEditor) {
 	final boolean tlsUseCheckBoxValue = getCheckBoxValue(R.id.settings_xmpp_use_tls);
@@ -481,15 +485,15 @@
 
 	if (getRegisteredXMPPTLSUse() != tlsUseCheckBoxValue)
 	    settingsEditor.putBoolean(getString(R.string.settings_key_xmpp_tls_use), tlsUseCheckBoxValue);
-	if (getRegisteredXMPPServer().equals(serverFieldValue) == false)
+	if (!getRegisteredXMPPServer().equals(serverFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_xmpp_server), serverFieldValue);
-	if (getRegisteredXMPPPort().equals(portFieldValue) == false)
+	if (!getRegisteredXMPPPort().equals(portFieldValue))
 	    settingsEditor.putString(getString(R.string.settings_key_xmpp_port), portFieldValue);
 	Log.i(getString(R.string.edit_settings_tag), LOG_MSG_XMPP_SETTINGS_REGISTERED);
     }
 
     /**
-     * Save settings in shared preferences
+     * Save settings in shared preferences.
      */
     private void saveSettings() {
 	final SharedPreferences.Editor settingsEditor = settings.edit();
@@ -504,7 +508,7 @@
 	String password = mAccPasswordField.getText().toString();
 	String username = mAccUsernameField.getText().toString();
 	String port = mXmppPortField.getText().toString();
-	if("".equals(password) || "".equals(username)
+	if ("".equals(password) || "".equals(username)
 	    || "".equals(port))
 	    settingsEditor.putBoolean(getString(R.string.PreferenceIsConfigured), false);
 	else