Make class Javadoc for tools consistent.

matthew_swift

04.17.2009 859bdd9b3b404bc61bb4f6cf02eda18f75a26c7f

Make class Javadoc for tools consistent.

 sdk/src/org/opends/sdk/tools/LDAPCompare.java

@@ -53,8 +53,8 @@


/**
 * This class provides a tool that can be used to issue compare requests
 * to the Directory Server.
 * A tool that can be used to issue Compare requests to the Directory
 * Server.
 */
public final class LDAPCompare extends ConsoleApplication
{
@@ -90,7 +90,7 @@
   * @return The error code.
   */

  public static int mainCompare(String[] args)
  static int mainCompare(String[] args)
  {
    return mainCompare(args, System.in, System.out, System.err);
  }
@@ -116,7 +116,7 @@
   *          <CODE>null</CODE> if standard error is not needed.
   * @return The error code.
   */
  public static int mainCompare(String[] args, InputStream inStream,
  static int mainCompare(String[] args, InputStream inStream,
      OutputStream outStream, OutputStream errStream)
  {
    return new LDAPCompare(inStream, outStream, errStream).run(args);

 sdk/src/org/opends/sdk/tools/LDAPModify.java

@@ -57,8 +57,8 @@


/**
 * This class provides a tool that can be used to issue modify requests
 * to the Directory Server.
 * A tool that can be used to issue update (Add/Delete/Modify/ModifyDN)
 * requests to the Directory Server.
 */
public final class LDAPModify extends ConsoleApplication
{
@@ -100,7 +100,7 @@
   * @return The error code.
   */

  public static int mainModify(String[] args)
  static int mainModify(String[] args)
  {
    return mainModify(args, System.in, System.out, System.err);
  }
@@ -126,7 +126,7 @@
   *          <CODE>null</CODE> if standard error is not needed.
   * @return The error code.
   */
  public static int mainModify(String[] args, InputStream inStream,
  static int mainModify(String[] args, InputStream inStream,
      OutputStream outStream, OutputStream errStream)
  {
    return new LDAPModify(inStream, outStream, errStream).run(args);

 sdk/src/org/opends/sdk/tools/LDAPPasswordModify.java

@@ -18,19 +18,19 @@

import com.sun.opends.sdk.util.Message;



/**
 * This program provides a utility that uses the LDAP password modify extended
 * operation to change the password for a user.  It exposes the three primary
 * A tool that can be used to issue LDAP password modify extended
 * requests to the Directory Server. It exposes the three primary
 * options available for this operation, which are:
 *
 * <UL>
 *   <LI>The user identity whose password should be changed.</LI>
 *   <LI>The current password for the user.</LI>
 *   <LI>The new password for the user.
 * </UL>
 *
 * All of these are optional components that may be included or omitted from the
 * request.
 * All of these are optional components that may be included or omitted
 * from the request.
 */
public class LDAPPasswordModify extends ConsoleApplication
{
@@ -65,7 +65,7 @@
   * @return  An integer value of zero if everything completed successfully, or
   *          a nonzero value if an error occurred.
   */
  public static int mainPasswordModify(String[] args)
  static int mainPasswordModify(String[] args)
  {
    return mainPasswordModify(args, System.in, System.out, System.err);
  }
@@ -91,7 +91,7 @@
   *          <CODE>null</CODE> if standard error is not needed.
   * @return The error code.
   */
  public static int mainPasswordModify(String[] args, InputStream inStream,
  static int mainPasswordModify(String[] args, InputStream inStream,
                                       OutputStream outStream, OutputStream errStream)
  {
    return new LDAPPasswordModify(inStream, outStream, errStream).run(args);

 sdk/src/org/opends/sdk/tools/LDAPSearch.java

@@ -57,8 +57,8 @@


/**
 * This class provides a tool that can be used to issue search requests
 * to the Directory Server.
 * A tool that can be used to issue Search requests to the Directory
 * Server.
 */
public final class LDAPSearch extends ConsoleApplication
{
@@ -208,7 +208,7 @@
   * @return The error code.
   */

  public static int mainSearch(String[] args)
  static int mainSearch(String[] args)
  {
    return mainSearch(args, true, System.in, System.out, System.err);
  }
@@ -232,7 +232,7 @@
   *          <CODE>null</CODE> if standard error is not needed.
   * @return The error code.
   */
  public static int mainSearch(String[] args, InputStream inStream,
  static int mainSearch(String[] args, InputStream inStream,
      OutputStream outStream, OutputStream errStream)
  {
    return mainSearch(args, true, inStream, outStream, errStream);
@@ -261,7 +261,7 @@
   * @return The error code.
   */

  public static int mainSearch(String[] args,
  static int mainSearch(String[] args,
      boolean returnMatchingEntries, InputStream inStream,
      OutputStream outStream, OutputStream errStream)
  {

 sdk/src/org/opends/sdk/tools/ModRate.java

@@ -44,8 +44,10 @@
import com.sun.opends.sdk.util.Message;



/**
 * Modrate benchmarking tool.
 * A load generation tool that can be used to load a Directory Server
 * with Modify requests using one or more LDAP connections.
 */
public final class ModRate extends ConsoleApplication
{
@@ -54,7 +56,7 @@


  /**
   * The main method for SearchRate tool.
   * The main method for ModRate tool.
   *
   * @param args
   *          The command-line arguments provided to this program.
@@ -74,14 +76,14 @@

  /**
   * Parses the provided command-line arguments and uses that
   * information to run the ldapsearch tool.
   * information to run the modrate tool.
   *
   * @param args
   *          The command-line arguments provided to this program.
   * @return The error code.
   */

  public static int mainSearchRate(String[] args)
  static int mainModRate(String[] args)
  {
    return mainModRate(args, System.in, System.out, System.err);
  }
@@ -90,7 +92,7 @@

  /**
   * Parses the provided command-line arguments and uses that
   * information to run the ldapsearch tool.
   * information to run the modrate tool.
   *
   * @param args
   *          The command-line arguments provided to this program.
@@ -106,7 +108,7 @@
   * @return The error code.
   */

  public static int mainModRate(String[] args, InputStream inStream,
  static int mainModRate(String[] args, InputStream inStream,
      OutputStream outStream, OutputStream errStream)

  {

 sdk/src/org/opends/sdk/tools/SearchRate.java

@@ -52,7 +52,8 @@


/**
 * Searchrate benchmarking tool.
 * A load generation tool that can be used to load a Directory Server
 * with Search requests using one or more LDAP connections.
 */
public final class SearchRate extends ConsoleApplication
{
@@ -89,7 +90,7 @@
   * @return The error code.
   */

  public static int mainSearchRate(String[] args)
  static int mainSearchRate(String[] args)
  {
    return mainSearchRate(args, System.in, System.out, System.err);
  }
@@ -114,7 +115,7 @@
   * @return The error code.
   */

  public static int mainSearchRate(String[] args, InputStream inStream,
  static int mainSearchRate(String[] args, InputStream inStream,
      OutputStream outStream, OutputStream errStream)

  {