</head>"); fakeXhtmlPageContent.append(String.format("<body>%s</body>", text)); fakeXhtmlPageContent.append("</html>"); - // validate Xhtml (without dangerous tags and event attributes) + // Validate Xhtml (with no dangerous tags and event attributes). try { SAXParserFactory factory = SAXParserFactory.newInstance(); factory.setValidating(true); @@ -432,7 +432,7 @@ public class MText extends MObject { } catch (IOException exception) { // cannot happen; put here not to bypass UnsupportedEncodingException } - // also convert named entities to numeric entities + // Also convert named entities to numeric entities. return MText.getXhtmlNumericEntitiesString(text); } diff --git a/src/java/com/marcozanon/macaco/text/MTranslator.java b/src/java/com/marcozanon/macaco/text/MTranslator.java index 3e88e5b..9e2a3b5 100644 --- a/src/java/com/marcozanon/macaco/text/MTranslator.java +++ b/src/java/com/marcozanon/macaco/text/MTranslator.java @@ -49,19 +49,19 @@ public class MTranslator extends MObject { return tmpMTranslator; } - /* File */ + /* File. */ protected String getFile() { return this.file; } - /* Locale */ + /* Locale. */ protected Locale getBasicLocale() { return this.basicLocale; } - /* Strings management */ + /* String management. */ protected LinkedHashMap<String, LinkedHashMap<String, String>> getMessagesReference() { return this.messages;

From: Marco Zanon Date: Tue, 27 Oct 2015 14:13:23 +0000 (+0000) Subject: Modified the comments to better fit the (virtual) coding guidelines. X-Git-Tag: 4.0~6 X-Git-Url: https://gitweb.marcozanon.com/?a=commitdiff_plain;h=c8aa94ea551fbbf038f72cf9409c93782618d78e;p=Macaco Modified the comments to better fit the (virtual) coding guidelines. --- diff --git a/src/java/com/marcozanon/macaco/MInformation.java b/src/java/com/marcozanon/macaco/MInformation.java index a7d0a67..c2766cf 100644 --- a/src/java/com/marcozanon/macaco/MInformation.java +++ b/src/java/com/marcozanon/macaco/MInformation.java @@ -16,7 +16,7 @@ public class MInformation extends MObject { public static final String TEXT_ENCODING = "UTF-8"; - /* Macaco information */ + /* Generic information. */ public static String getMacacoVersion() { return MInformation.MACACO_VERSION; @@ -35,7 +35,7 @@ public class MInformation extends MObject { return s.toString(); } - /* Exceptions */ + /* Exceptions. */ public static String getExceptionAsString(Exception exception) { if (null == exception) { diff --git a/src/java/com/marcozanon/macaco/conversion/MDateConverter.java b/src/java/com/marcozanon/macaco/conversion/MDateConverter.java index 37c6afd..4a53334 100644 --- a/src/java/com/marcozanon/macaco/conversion/MDateConverter.java +++ b/src/java/com/marcozanon/macaco/conversion/MDateConverter.java @@ -50,7 +50,7 @@ public class MDateConverter extends MObject { return new MDateConverter(this.getDateFormats(), this.getLocale(), this.getTimeZone()); } - /* Date formats */ + /* Date formats. */ public void setDateFormats(LinkedHashSet dateFormats) { if (null == dateFormats) { @@ -93,7 +93,7 @@ public class MDateConverter extends MObject { return this.getDateFormatsReference().iterator().next(); } - /* Locale */ + /* Locale. */ protected void setLocale(Locale locale) { if (null == locale) { @@ -107,7 +107,7 @@ public class MDateConverter extends MObject { return this.locale; } - /* Time zone */ + /* Time zone. */ protected void setTimeZone(TimeZone timeZone) { if (null == timeZone) { @@ -125,7 +125,7 @@ public class MDateConverter extends MObject { return (TimeZone)this.getTimeZoneReference().clone(); } - /* Conversion */ + /* Conversions. */ protected static void checkDateFormat(String dateFormat) { if (MText.isBlank(dateFormat)) { @@ -216,7 +216,7 @@ public class MDateConverter extends MObject { return this.getStringFromDateByParameters(x, this.getDefaultDateFormat(), this.getLocale(), this.getTimeZoneReference()); } - /* Helper methods */ + /* Helpers. */ public static Date getFlatDate(Date x) { if (null == x) { diff --git a/src/java/com/marcozanon/macaco/conversion/MNumberConverter.java b/src/java/com/marcozanon/macaco/conversion/MNumberConverter.java index 6bcc008..2b69a63 100644 --- a/src/java/com/marcozanon/macaco/conversion/MNumberConverter.java +++ b/src/java/com/marcozanon/macaco/conversion/MNumberConverter.java @@ -41,7 +41,7 @@ public class MNumberConverter extends MObject { return new MNumberConverter(this.getNumberFormats(), this.getLocale()); } - /* Number formats */ + /* Number formats. */ public void setNumberFormats(LinkedHashSet numberFormats) { if (null == numberFormats) { @@ -84,7 +84,7 @@ public class MNumberConverter extends MObject { return this.getNumberFormatsReference().iterator().next(); } - /* Locale */ + /* Locale. */ protected void setLocale(Locale locale) { if (null == locale) { @@ -98,7 +98,7 @@ public class MNumberConverter extends MObject { return this.locale; } - /* Conversion */ + /* Conversions. */ protected static void checkNumberFormat(String numberFormat) { if (MText.isBlank(numberFormat)) { diff --git a/src/java/com/marcozanon/macaco/json/MJsonArray.java b/src/java/com/marcozanon/macaco/json/MJsonArray.java index 10f680b..1b170bc 100644 --- a/src/java/com/marcozanon/macaco/json/MJsonArray.java +++ b/src/java/com/marcozanon/macaco/json/MJsonArray.java @@ -42,7 +42,7 @@ public class MJsonArray extends MJsonValue { return tmpMJsonArray; } - /* Values handlers */ + /* Value handlers. */ public void addValue(MJsonValue x) { if (null == x) { @@ -91,7 +91,7 @@ public class MJsonArray extends MJsonValue { this.getValuesReference().clear(); } - /* Parsers */ + /* Parsers. */ protected static int getTokenLength(String x) { if (null == x) { @@ -190,7 +190,7 @@ public class MJsonArray extends MJsonValue { } } - /* Formatter */ + /* Formatter. */ public String getJsonValue() { StringBuilder s = new StringBuilder(""); diff --git a/src/java/com/marcozanon/macaco/json/MJsonBoolean.java b/src/java/com/marcozanon/macaco/json/MJsonBoolean.java index a3c4162..313e9c5 100644 --- a/src/java/com/marcozanon/macaco/json/MJsonBoolean.java +++ b/src/java/com/marcozanon/macaco/json/MJsonBoolean.java @@ -34,7 +34,7 @@ public class MJsonBoolean extends MJsonValue { return tmpMJsonBoolean; } - /* Value handlers */ + /* Value handlers. */ public void setValue(Boolean x) { if (null == x) { @@ -48,7 +48,7 @@ public class MJsonBoolean extends MJsonValue { return this.value; } - /* Parsers */ + /* Parsers. */ protected static int getTokenLength(String x) { if (null == x) { @@ -75,7 +75,7 @@ public class MJsonBoolean extends MJsonValue { this.setValue(Boolean.valueOf(x)); } - /* Formatter */ + /* Formatter. */ public String getJsonValue() { return this.getValue().toString(); diff --git a/src/java/com/marcozanon/macaco/json/MJsonNull.java b/src/java/com/marcozanon/macaco/json/MJsonNull.java index 4426340..356916a 100644 --- a/src/java/com/marcozanon/macaco/json/MJsonNull.java +++ b/src/java/com/marcozanon/macaco/json/MJsonNull.java @@ -32,7 +32,7 @@ public class MJsonNull extends MJsonValue { return tmpMJsonNull; } - /* Parsers */ + /* Parsers. */ protected static int getTokenLength(String x) { if (null == x) { @@ -55,7 +55,7 @@ public class MJsonNull extends MJsonValue { } } - /* Formatter */ + /* Formatter. */ public String getJsonValue() { return "null"; diff --git a/src/java/com/marcozanon/macaco/json/MJsonNumber.java b/src/java/com/marcozanon/macaco/json/MJsonNumber.java index 0443603..5bd4859 100644 --- a/src/java/com/marcozanon/macaco/json/MJsonNumber.java +++ b/src/java/com/marcozanon/macaco/json/MJsonNumber.java @@ -35,7 +35,7 @@ public class MJsonNumber extends MJsonValue { return tmpMJsonNumber; } - /* Value handlers */ + /* Value handlers. */ public void setValue(Number x) { if (null == x) { @@ -49,7 +49,7 @@ public class MJsonNumber extends MJsonValue { return this.value; } - /* Parsers */ + /* Parsers. */ protected static int getTokenLength(String x) { if (null == x) { @@ -95,7 +95,7 @@ public class MJsonNumber extends MJsonValue { this.setValue(y); } - /* Formatter */ + /* Formatter. */ public String getJsonValue() { return this.getValue().toString(); diff --git a/src/java/com/marcozanon/macaco/json/MJsonObject.java b/src/java/com/marcozanon/macaco/json/MJsonObject.java index bb42c7f..6c5060a 100644 --- a/src/java/com/marcozanon/macaco/json/MJsonObject.java +++ b/src/java/com/marcozanon/macaco/json/MJsonObject.java @@ -45,7 +45,7 @@ public class MJsonObject extends MJsonValue { return tmpMJsonObject; } - /* Values handlers */ + /* Value handlers. */ public void setValue(String key, MJsonValue x) { if (MText.isBlank(key)) { @@ -108,7 +108,7 @@ public class MJsonObject extends MJsonValue { return keys; } - /* Parsers */ + /* Parsers. */ protected static int getTokenLength(String x) { if (null == x) { @@ -240,7 +240,7 @@ public class MJsonObject extends MJsonValue { } } - /* Formatter */ + /* Formatter. */ public String getJsonValue() { StringBuilder s = new StringBuilder(""); diff --git a/src/java/com/marcozanon/macaco/json/MJsonString.java b/src/java/com/marcozanon/macaco/json/MJsonString.java index ba42617..173c0c4 100644 --- a/src/java/com/marcozanon/macaco/json/MJsonString.java +++ b/src/java/com/marcozanon/macaco/json/MJsonString.java @@ -41,7 +41,7 @@ public class MJsonString extends MJsonValue { return tmpMJsonString; } - /* Extended escape mode */ + /* Extended escape mode. */ public void setExtendedEscapeMode(boolean extendedEscapeMode) { this.extendedEscapeMode = extendedEscapeMode; @@ -51,7 +51,7 @@ public class MJsonString extends MJsonValue { return this.extendedEscapeMode; } - /* Value handlers */ + /* Value handlers. */ public void setValue(String x) { if (null == x) { @@ -65,7 +65,7 @@ public class MJsonString extends MJsonValue { return this.value; } - /* Helpers */ + /* Helpers. */ protected static String getEscapedString(String x, boolean extendedEscapeMode) { if (null == x) { @@ -235,7 +235,7 @@ public class MJsonString extends MJsonValue { return y.toString(); } - /* Parsers */ + /* Parsers. */ protected static int getTokenLength(String x) { if (null == x) { @@ -283,7 +283,7 @@ public class MJsonString extends MJsonValue { this.setValue(MJsonString.getUnescapedString(y)); } - /* Formatter */ + /* Formatter. */ public String getJsonValue() { return "\"" + MJsonString.getEscapedString(this.getValue(), this.getExtendedEscapeMode()) + "\""; diff --git a/src/java/com/marcozanon/macaco/json/MJsonValue.java b/src/java/com/marcozanon/macaco/json/MJsonValue.java index e08b7a9..ac63400 100644 --- a/src/java/com/marcozanon/macaco/json/MJsonValue.java +++ b/src/java/com/marcozanon/macaco/json/MJsonValue.java @@ -14,7 +14,7 @@ public abstract class MJsonValue extends MObject { public abstract MJsonValue clone(); - /* Helpers */ + /* Helpers. */ protected static boolean isWhitespace(int c) { return ((' ' == c) || ('\t' == c) || ('\n' == c) || ('\r' == c)); @@ -36,7 +36,7 @@ public abstract class MJsonValue extends MObject { return ((']' == c) || ('}' == c)); } - /* Formatter */ + /* Formatter. */ public abstract String getJsonValue(); diff --git a/src/java/com/marcozanon/macaco/logging/MLogDatabaseTable.java b/src/java/com/marcozanon/macaco/logging/MLogDatabaseTable.java index ed0a196..5c4610b 100644 --- a/src/java/com/marcozanon/macaco/logging/MLogDatabaseTable.java +++ b/src/java/com/marcozanon/macaco/logging/MLogDatabaseTable.java @@ -59,13 +59,13 @@ public class MLogDatabaseTable extends MLogTarget { } } - /* Sql connection generator */ + /* Sql connection generator. */ protected MSqlConnectionGenerator getSqlConnectionGeneratorReference() { return this.sqlConnectionGenerator; } - /* Logging database parameters */ + /* Database logging parameters. */ protected String getLogDatabaseTable() { return this.logDatabaseTable; @@ -79,13 +79,13 @@ public class MLogDatabaseTable extends MLogTarget { return this.logDatabaseField; } - /* Sql connection */ + /* Sql connection. */ protected MSqlConnection getSqlConnectionReference() { return this.sqlConnection; } - /* Output */ + /* Output. */ public void appendMessage(String message) throws MLoggingException { this.appendMessage(message, 0); diff --git a/src/java/com/marcozanon/macaco/logging/MLogFilter.java b/src/java/com/marcozanon/macaco/logging/MLogFilter.java index 5a380af..4669c92 100644 --- a/src/java/com/marcozanon/macaco/logging/MLogFilter.java +++ b/src/java/com/marcozanon/macaco/logging/MLogFilter.java @@ -46,7 +46,7 @@ public class MLogFilter extends MObject { } } - /* Threshold */ + /* Threshold. */ public void setThreshold(MLogFilter.Threshold threshold) { if (null == threshold) { @@ -60,7 +60,7 @@ public class MLogFilter extends MObject { return this.threshold; } - /* Log targets */ + /* Log targets. */ public void addLogTarget(MLogTarget logTarget) { if (null == logTarget) { @@ -76,7 +76,7 @@ public class MLogFilter extends MObject { return this.logTargets; } - /* Output */ + /* Output. */ public void setPausedState(boolean pausedState) throws MLoggingException { this.pausedState = pausedState; diff --git a/src/java/com/marcozanon/macaco/logging/MLogMessage.java b/src/java/com/marcozanon/macaco/logging/MLogMessage.java index becf101..018ed71 100644 --- a/src/java/com/marcozanon/macaco/logging/MLogMessage.java +++ b/src/java/com/marcozanon/macaco/logging/MLogMessage.java @@ -27,7 +27,7 @@ public class MLogMessage extends MObject { this.indentation = indentation; } - /* Values */ + /* Values. */ public String getMessage() { return this.message; diff --git a/src/java/com/marcozanon/macaco/logging/MLogPlainTextFile.java b/src/java/com/marcozanon/macaco/logging/MLogPlainTextFile.java index 45f0a64..0f225d5 100644 --- a/src/java/com/marcozanon/macaco/logging/MLogPlainTextFile.java +++ b/src/java/com/marcozanon/macaco/logging/MLogPlainTextFile.java @@ -52,19 +52,19 @@ public class MLogPlainTextFile extends MLogTarget { } } - /* File */ + /* File. */ protected String getFile() { return this.file; } - /* Buffer */ + /* Buffer. */ protected BufferedWriter getBufferReference() { return this.buffer; } - /* Output */ + /* Output. */ public void appendMessage(String message) throws MLoggingException { this.appendMessage(message, 0); diff --git a/src/java/com/marcozanon/macaco/logging/MLogTarget.java b/src/java/com/marcozanon/macaco/logging/MLogTarget.java index 01a256f..7e9bb7a 100644 --- a/src/java/com/marcozanon/macaco/logging/MLogTarget.java +++ b/src/java/com/marcozanon/macaco/logging/MLogTarget.java @@ -22,7 +22,7 @@ public abstract class MLogTarget extends MObject { } } - /* Output */ + /* Output. */ public abstract void appendMessage(String message) throws MLoggingException; diff --git a/src/java/com/marcozanon/macaco/sql/MSqlConnection.java b/src/java/com/marcozanon/macaco/sql/MSqlConnection.java index 9ea683e..dc8c5ea 100644 --- a/src/java/com/marcozanon/macaco/sql/MSqlConnection.java +++ b/src/java/com/marcozanon/macaco/sql/MSqlConnection.java @@ -53,7 +53,7 @@ public class MSqlConnection extends MObject { this.url = url; this.username = username; this.password = password; - // load driver + // Load driver. try { Class.forName(this.getDriver()).newInstance(); } @@ -66,14 +66,14 @@ public class MSqlConnection extends MObject { catch (InstantiationException exception) { throw new MSqlConnectionFailureException("Could not load driver.", exception); } - // establish connection + // Establish a connection. try { this.connection = DriverManager.getConnection(this.getUrl(), this.getUsername(), this.getPassword()); } catch (SQLException exception) { throw new MSqlConnectionFailureException("Could not get connection.", exception); } - // set SQL mode + // Set SQL mode to standard ANSI. try { this.getConnectionReference().createStatement().executeUpdate("SET SQL_MODE='ANSI'"); } @@ -108,37 +108,37 @@ public class MSqlConnection extends MObject { } } - /* Driver */ + /* Driver. */ public String getDriver() { return this.driver; } - /* Url */ + /* Url. */ public String getUrl() { return this.url; } - /* Username */ + /* Username. */ public String getUsername() { return this.username; } - /* Password */ + /* Password. */ public String getPassword() { return this.password; } - /* Connection */ + /* Connection. */ protected Connection getConnectionReference() { return this.connection; } - /* Transactions */ + /* Transactions. */ protected void setTransactionStatus(MSqlConnection.TransactionStatus transactionStatus) { if (null == transactionStatus) { @@ -202,7 +202,7 @@ public class MSqlConnection extends MObject { } } - /* Statements */ + /* Statements. */ public MSqlStatementResults executePreparedStatement(String statement) throws MSqlStatementException { return this.executePreparedStatement(statement, new LinkedList