MarshalledObject.java, [...]: Fixed javadoc, coding style and argument names all over.

2004-04-20  Michael Koch  <konqueror@gmx.de>

	* java/rmi/MarshalledObject.java,
	java/rmi/Naming.java,
	java/rmi/RemoteException.java,
	java/rmi/activation/ActivationException.java,
	java/rmi/server/ServerCloneException.java,
	java/security/AccessController.java,
	java/security/AlgorithmParameterGenerator.java,
	java/security/AlgorithmParameters.java,
	java/security/CodeSource.java,
	java/security/Identity.java,
	java/security/IdentityScope.java,
	java/security/KeyPairGenerator.java,
	java/security/KeyStore.java,
	java/security/Security.java,
	java/security/Signature.java,
	java/security/SignatureSpi.java,
	java/security/SignedObject.java,
	java/security/spec/DSAParameterSpec.java,
	java/security/spec/DSAPrivateKeySpec.java,
	java/security/spec/DSAPublicKeySpec.java,
	java/sql/Array.java,
	java/sql/DatabaseMetaData.java,
	java/sql/ResultSet.java,
	java/text/ChoiceFormat.java,
	java/text/CollationElementIterator.java,
	java/text/CollationKey.java,
	java/text/Collator.java,
	java/text/DateFormat.java,
	java/text/DateFormatSymbols.java,
	java/text/DecimalFormatSymbols.java,
	java/text/Format.java,
	java/text/ParsePosition.java,
	java/text/RuleBasedCollator.java,
	java/text/SimpleDateFormat.java,
	java/text/StringCharacterIterator.java,
	java/util/Collections.java,
	java/util/PropertyResourceBundle.java,
	java/util/ResourceBundle.java,
	java/util/StringTokenizer.java,
	java/util/jar/Attributes.java,
	java/util/logging/ConsoleHandler.java,
	java/util/logging/LogManager.java,
	java/util/logging/MemoryHandler.java,
	java/util/logging/SocketHandler.java,
	javax/naming/NamingException.java:
	Fixed javadoc, coding style and argument names all over.

From-SVN: r80906
This commit is contained in:
Michael Koch 2004-04-20 14:45:10 +00:00 committed by Michael Koch
parent 386d3a1616
commit a17c9f2ea1
46 changed files with 441 additions and 386 deletions

View file

@ -45,7 +45,7 @@ import java.util.Vector;
* To use this class, first specify two lists of formats and range terminators.
* These lists must be arrays of equal length. The format of index
* <code>i</code> will be selected for value <code>X</code> if
* <code>terminator[i] <= X < limit[i + 1]</code>. If the value X is not
* <code>terminator[i] &lt;= X &lt; limit[i + 1]</code>. If the value X is not
* included in any range, then either the first or last format will be
* used depending on whether the value X falls outside the range.
* <p>
@ -196,10 +196,10 @@ public class ChoiceFormat extends NumberFormat
* This method tests this object for equality with the specified
* object. This will be true if and only if:
* <ul>
* <li>The specified object is not <code>null</code>.
* <li>The specified object is an instance of <code>ChoiceFormat</code>.
* <li>The specified object is not <code>null</code>.</li>
* <li>The specified object is an instance of <code>ChoiceFormat</code>.</li>
* <li>The termination ranges and format strings are identical to
* this object's.
* this object's. </li>
* </ul>
*
* @param obj The object to test for equality against.

View file

@ -129,7 +129,7 @@ public final class CollationElementIterator
/**
* This method resets the internal position pointer to read from the
* beginning of the <code>String again.
* beginning of the <code>String</code> again.
*/
public void reset()
{

View file

@ -140,12 +140,12 @@ public final class CollationKey implements Comparable
* this object. This will be true if and only if:
* <p>
* <ul>
* <li>The specified object must not be <code>null</code>
* <li>The specified object is an instance of <code>CollationKey</code>.
* <li>The specified object must not be <code>null</code></li>
* <li>The specified object is an instance of <code>CollationKey</code>.</li>
* <li>The specified object was created from the same <code>Collator</code>
* as this object.
* as this object.</li>
* <li>The specified object has the same source string and bit key as
* this object.
* this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality.

View file

@ -183,10 +183,10 @@ public abstract class Collator implements Comparator, Cloneable
* object. This will be true if and only if the following conditions are
* met:
* <ul>
* <li>The specified object is not <code>null</code>.
* <li>The specified object is an instance of <code>Collator</code>.
* <li>The specified object is not <code>null</code>.</li>
* <li>The specified object is an instance of <code>Collator</code>.</li>
* <li>The specified object has the same strength and decomposition
* settings as this object.
* settings as this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality against

View file

@ -196,9 +196,9 @@ public abstract class DateFormat extends Format implements Cloneable
* object:
* <P>
* <ul>
* <li>Is not <code>null</code>.
* <li>Is an instance of <code>DateFormat</code>.
* <li>Has the same numberFormat field value as this object.
* <li>Is not <code>null</code>.</li>
* <li>Is an instance of <code>DateFormat</code>.</li>
* <li>Has the same numberFormat field value as this object.</li>
* </ul>
*
* @param obj The object to test for equality against.

View file

@ -245,11 +245,12 @@ public class DateFormatSymbols implements java.io.Serializable, Cloneable
* the array contains five values:
* <P>
* <ul>
* <li>0 - The non-localized time zone id string.
* <li>1 - The long name of the time zone (standard time).
* <li>2 - The short name of the time zone (standard time).
* <li>3 - The long name of the time zone (daylight savings time).
* <li>4 - the short name of the time zone (daylight savings time).
* <li>0 - The non-localized time zone id string.</li>
* <li>1 - The long name of the time zone (standard time).</li>
* <li>2 - The short name of the time zone (standard time).</li>
* <li>3 - The long name of the time zone (daylight savings time).</li>
* <li>4 - the short name of the time zone (daylight savings time).</li>
* </ul>
*
* @return The list of time zone display strings.
*/
@ -386,11 +387,12 @@ public class DateFormatSymbols implements java.io.Serializable, Cloneable
* the array contains five values:
* <P>
* <ul>
* <li>0 - The non-localized time zone id string.
* <li>1 - The long name of the time zone (standard time).
* <li>2 - The short name of the time zone (standard time).
* <li>3 - The long name of the time zone (daylight savings time).
* <li>4 - the short name of the time zone (daylight savings time).
* <li>0 - The non-localized time zone id string.</li>
* <li>1 - The long name of the time zone (standard time).</li>
* <li>2 - The short name of the time zone (standard time).</li>
* <li>3 - The long name of the time zone (daylight savings time).</li>
* <li>4 - the short name of the time zone (daylight savings time).</li>
* </ul>
*
* @return The list of time zone display strings.
*/
@ -438,15 +440,15 @@ public class DateFormatSymbols implements java.io.Serializable, Cloneable
* This will be true if and only if the specified object:
* <p>
* <ul>
* <li> Is not <code>null</code>.
* <li> Is an instance of <code>DateFormatSymbols</code>.
* <li> Contains identical formatting symbols to this object.
* <li> Is not <code>null</code>.</li>
* <li> Is an instance of <code>DateFormatSymbols</code>.</li>
* <li> Contains identical formatting symbols to this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality against.
*
* @return <code>true</code> if the specified object is equal to this one,
* </code>false</code> otherwise.
* <code>false</code> otherwise.
*/
public boolean equals (Object obj)
{

View file

@ -167,9 +167,9 @@ public final class DecimalFormatSymbols implements Cloneable, Serializable
* regard to the specified object:
* <p>
* <ul>
* <li>It is not <code>null</code>.
* <li>It is an instance of <code>DecimalFormatSymbols</code>
* <li>All of its symbols are identical to the symbols in this object.
* <li>It is not <code>null</code>.</li>
* <li>It is an instance of <code>DecimalFormatSymbols</code>.</li>
* <li>All of its symbols are identical to the symbols in this object.</li>
* </ul>
*
* @return <code>true</code> if the specified object is equal to this

View file

@ -123,7 +123,7 @@ public abstract class Format implements Serializable, Cloneable
* This method parses a <code>String</code> and converts the parsed
* contents into an <code>Object</code>.
*
* @param str The <code>String to parse.
* @param str The <code>String</code> to parse.
*
* @return The resulting <code>Object</code>.
*

View file

@ -116,10 +116,10 @@ public class ParsePosition
* all of the following conditions are met.
* <p>
* <ul>
* <li>The specified object is not <code>null</code>.
* <li>The specified object is an instance of <code>ParsePosition</code>.
* <li>The specified object is not <code>null</code>.</li>
* <li>The specified object is an instance of <code>ParsePosition</code>.</li>
* <li>The specified object has the same index and error index as
* this object.
* this object.</li>
* </ul>
*
* @param obj The <code>Object</code> to test for equality against

View file

@ -56,9 +56,9 @@ import java.util.Vector;
* <p>
* Rules take the form of a <code>String</code> with the following syntax
* <ul>
* <li> Modifier: '@'
* <li> Relation: '&lt;' | ';' | ',' | '=' : <text>
* <li> Reset: '&amp;' : <text>
* <li> Modifier: '@'</li>
* <li> Relation: '&lt;' | ';' | ',' | '=' : &lt;text&gt;</li>
* <li> Reset: '&amp;' : &lt;text&gt;</li>
* </ul>
* The modifier character indicates that accents sort backward as is the
* case with French. The modifier applies to all rules <b>after</b>
@ -69,12 +69,12 @@ import java.util.Vector;
* the following meanings:
* <ul>
* <li>'&lt;' - The text argument is greater than the prior term at the primary
* difference level.
* difference level.</li>
* <li>';' - The text argument is greater than the prior term at the secondary
* difference level.
* difference level.</li>
* <li>',' - The text argument is greater than the prior term at the tertiary
* difference level.
* <li>'=' - The text argument is equal to the prior term
* difference level.</li>
* <li>'=' - The text argument is equal to the prior term</li>
* </ul>
* <p>
* As for the text argument itself, this is any sequence of Unicode
@ -131,15 +131,15 @@ import java.util.Vector;
* A <code>ParseException</code> will be thrown for any of the following
* conditions:
* <ul>
* <li>Unquoted punctuation characters in a text argument.
* <li>A relational or reset operator not followed by a text argument
* <li>Unquoted punctuation characters in a text argument.</li>
* <li>A relational or reset operator not followed by a text argument</li>
* <li>A reset operator where the text argument is not present in
* the previous rule string section.
* the previous rule string section.</li>
* </ul>
*
* @author Aaron M. Renn <arenn@urbanophile.com>
* @author Tom Tromey <tromey@cygnus.com>
* @author Guilhem Lavaux <guilhem@kaffe.org>
* @author Aaron M. Renn (arenn@urbanophile.com)
* @author Tom Tromey (tromey@cygnus.com)
* @author Guilhem Lavaux (guilhem@kaffe.org)
*/
public class RuleBasedCollator extends Collator
{

View file

@ -358,13 +358,13 @@ public class SimpleDateFormat extends DateFormat
* object. This will be true if and only if the specified object:
* <p>
* <ul>
* <li>Is not <code>null</code>.
* <li>Is an instance of <code>SimpleDateFormat</code>.
* <li>Is not <code>null</code>.</li>
* <li>Is an instance of <code>SimpleDateFormat</code>.</li>
* <li>Is equal to this object at the superclass (i.e., <code>DateFormat</code>)
* level.
* <li>Has the same formatting pattern.
* <li>Is using the same formatting symbols.
* <li>Is using the same century for two digit years.
* level.</li>
* <li>Has the same formatting pattern.</li>
* <li>Is using the same formatting symbols.</li>
* <li>Is using the same century for two digit years.</li>
* </ul>
*
* @param obj The object to compare for equality against.

View file

@ -314,10 +314,10 @@ public final class StringCharacterIterator implements CharacterIterator
* object. This will be true if and only if the specified object:
* <p>
* <ul>
* <li>is not <code>null</code>.
* <li>is an instance of <code>StringCharacterIterator</code>
* <li>has the same text as this object
* <li>has the same beginning, ending, and current index as this object.
* <li>is not <code>null</code>.</li>
* <li>is an instance of <code>StringCharacterIterator</code></li>
* <li>has the same text as this object</li>
* <li>has the same beginning, ending, and current index as this object.</li>
* </ul>
*
* @param obj The object to test for equality against.