From c5a1d42eb8234c99c5b93dc60dd3122373d7d7e4 Mon Sep 17 00:00:00 2001
From: kenneth_suter <kenneth_suter@localhost>
Date: Mon, 27 Aug 2007 15:38:14 +0000
Subject: [PATCH] Removed {@inheritDoc} tags from messages package method declarations that inherit directly from Java core methods and replaced them with comments derived in most part from the parent methods
---
opends/src/messages/src/org/opends/messages/Message.java | 70 ++++++++++++++++++++++++++++++++---
opends/src/messages/src/org/opends/messages/MessageBuilder.java | 44 ++++++++++++++++++++-
2 files changed, 105 insertions(+), 9 deletions(-)
diff --git a/opends/src/messages/src/org/opends/messages/Message.java b/opends/src/messages/src/org/opends/messages/Message.java
index 65efcb9..7240bea 100644
--- a/opends/src/messages/src/org/opends/messages/Message.java
+++ b/opends/src/messages/src/org/opends/messages/Message.java
@@ -318,10 +318,47 @@
}
/**
- * {@inheritDoc}
+ * Formats the object using the provided {@link Formatter formatter}.
+ *
+ * @param formatter
+ * The {@link Formatter formatter}.
+ *
+ * @param flags
+ * The flags modify the output format. The value is interpreted as
+ * a bitmask. Any combination of the following flags may be set:
+ * {@link java.util.FormattableFlags#LEFT_JUSTIFY}, {@link
+ * java.util.FormattableFlags#UPPERCASE}, and {@link
+ * java.util.FormattableFlags#ALTERNATE}. If no flags are set, the
+ * default formatting of the implementing class will apply.
+ *
+ * @param width
+ * The minimum number of characters to be written to the output.
+ * If the length of the converted value is less than the
+ * <tt>width</tt> then the output will be padded by
+ * <tt>' '</tt> until the total number of characters
+ * equals width. The padding is at the beginning by default. If
+ * the {@link java.util.FormattableFlags#LEFT_JUSTIFY} flag is set
+ * then the padding will be at the end. If <tt>width</tt> is
+ * <tt>-1</tt> then there is no minimum.
+ *
+ * @param precision
+ * The maximum number of characters to be written to the output.
+ * The precision is applied before the width, thus the output will
+ * be truncated to <tt>precision</tt> characters even if the
+ * <tt>width</tt> is greater than the <tt>precision</tt>. If
+ * <tt>precision</tt> is <tt>-1</tt> then there is no explicit
+ * limit on the number of characters.
+ *
+ * @throws IllegalFormatException
+ * If any of the parameters are invalid. For specification of all
+ * possible formatting errors, see the <a
+ * href="../util/Formatter.html#detail">Details</a> section of the
+ * formatter class specification.
*/
public void formatTo(Formatter formatter, int flags,
- int width, int precision) {
+ int width, int precision)
+ throws IllegalFormatException
+ {
// Ignores flags, width and precission for now.
// see javadoc for Formattable
Locale l = formatter.locale();
@@ -343,15 +380,32 @@
}
/**
- * {@inheritDoc}
+ * Compares this object with the specified object for order. Returns a
+ * negative integer, zero, or a positive integer as this object is less
+ * than, equal to, or greater than the specified object.
+ *
+ * @param o the object to be compared.
+ * @return a negative integer, zero, or a positive integer as this object
+ * is less than, equal to, or greater than the specified object.
+ *
+ * @throws ClassCastException if the specified object's type prevents it
+ * from being compared to this object.
*/
- public int compareTo(Object o) {
+ public int compareTo(Object o) throws ClassCastException {
Message thatMessage = (Message)o;
return toString().compareTo(thatMessage.toString());
}
/**
- * {@inheritDoc}
+ * Indicates whether some other message is "equal to" this one. Messages
+ * are considered equal if their string representation in the default
+ * locale are equal.
+ *
+ * @param o the reference object with which to compare.
+ * @return <code>true</code> if this object is the same as the obj
+ * argument; <code>false</code> otherwise.
+ * @see #hashCode()
+ * @see java.util.Hashtable
*/
public boolean equals(Object o) {
if (this == o) return true;
@@ -363,7 +417,11 @@
}
/**
- * {@inheritDoc}
+ * Returns a hash code value for the object.
+ *
+ * @return a hash code value for this object.
+ * @see java.lang.Object#equals(java.lang.Object)
+ * @see java.util.Hashtable
*/
public int hashCode() {
int result;
diff --git a/opends/src/messages/src/org/opends/messages/MessageBuilder.java b/opends/src/messages/src/org/opends/messages/MessageBuilder.java
index 0b4f5de..418576f 100644
--- a/opends/src/messages/src/org/opends/messages/MessageBuilder.java
+++ b/opends/src/messages/src/org/opends/messages/MessageBuilder.java
@@ -170,22 +170,60 @@
}
/**
- * {@inheritDoc}
+ * Appends a subsequence of the specified character sequence to this
+ * <tt>Appendable</tt>.
+ *
+ * <p> An invocation of this method of the form <tt>out.append(csq, start,
+ * end)</tt> when <tt>csq</tt> is not <tt>null</tt>, behaves in
+ * exactly the same way as the invocation
+ *
+ * <pre>
+ * out.append(csq.subSequence(start, end)) </pre>
+ *
+ * @param csq
+ * The character sequence from which a subsequence will be
+ * appended. If <tt>csq</tt> is <tt>null</tt>, then characters
+ * will be appended as if <tt>csq</tt> contained the four
+ * characters <tt>"null"</tt>.
+ *
+ * @param start
+ * The index of the first character in the subsequence
+ *
+ * @param end
+ * The index of the character following the last character in the
+ * subsequence
+ *
+ * @return A reference to this <tt>Appendable</tt>
+ *
+ * @throws IndexOutOfBoundsException
+ * If <tt>start</tt> or <tt>end</tt> are negative, <tt>start</tt>
+ * is greater than <tt>end</tt>, or <tt>end</tt> is greater than
+ * <tt>csq.length()</tt>
*/
public MessageBuilder append(CharSequence csq, int start, int end)
+ throws IndexOutOfBoundsException
{
return append(csq.subSequence(start, end));
}
/**
- * {@inheritDoc}
+ * Appends the specified character to this <tt>Appendable</tt>.
+ *
+ * @param c
+ * The character to append
+ *
+ * @return A reference to this <tt>Appendable</tt>
*/
public MessageBuilder append(char c) {
return append(String.valueOf(c));
}
/**
- * {@inheritDoc}
+ * Returns a string containing the characters in this sequence in the same
+ * order as this sequence. The length of the string will be the length of
+ * this sequence.
+ *
+ * @return a string consisting of exactly this sequence of characters
*/
public String toString() {
return sb.toString();
--
Gitblit v1.10.0