Checkpoint for OPENDJ-1303 "opendj-cli" - added javadoc for arguments which...

Violette Roche-Montane

21.35.2014 80727f4d026711c8aed89e2afaed4c13d69b082f

Checkpoint for OPENDJ-1303 "opendj-cli"
- added javadoc for arguments which share the same short ID. (TBC...)
- added argument constants.

 opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentConstants.java

@@ -650,6 +650,61 @@
     */
    public static final String OPTION_LONG_CONTROL = "control";

    /**
     * Recurring task option long form.
     */
    public static final String OPTION_LONG_RECURRING_TASK = "recurringTask";

    /**
     * Recurring task option short form.
     */
    public static final Character OPTION_SHORT_RECURRING_TASK = null;

    /**
     * Subentries control option long form.
     */
    public static final String OPTION_LONG_SUBENTRIES = "subEntries";

    /**
     * Subentries control option short form.
     */
    public static final Character OPTION_SHORT_SUBENTRIES = null;

    /**
     * Scheduled start date/time option long form.
     */
    public static final String OPTION_LONG_START_DATETIME = "start";

    /**
     * Scheduled start date/time option short form.
     */
    public static final Character OPTION_SHORT_START_DATETIME = 't';

    /**
     * Long form of admin password.
     */
    public static final String OPTION_LONG_ADMIN_PWD = "adminPassword";

    /**
     * Long form of admin password file.
     */
    public static final String OPTION_LONG_ADMIN_PWD_FILE = "adminPasswordFile";

    /**
     * The name of the SASL property that can be used to provide trace information
     * for a SASL ANONYMOUS request.
     */
    public static final String SASL_PROPERTY_TRACE = "trace";

    /**
     * The value for the long option force upgrade.
     */
    public static final String OPTION_LONG_FORCE_UPGRADE = "force";

    /**
     * The value for the long option ignore errors.
     */
    public static final String OPTION_LONG_IGNORE_ERRORS = "ignoreErrors";
    // Prevent instantiation.
    private ArgumentConstants() {


 opendj-cli/src/main/java/com/forgerock/opendj/cli/CommonArguments.java

@@ -265,7 +265,7 @@
    /**
     * Returns the "targetldif" string argument.
     * <br><i> N.B : the 't' short option is also used by timelimit,
     * testonly, trustmanagerproviderdn, stoptime.</i>
     * testonly, trustmanagerproviderdn, stoptime, start(dateTime).</i>
     *
     * @param description
     *            The description of this argument.
@@ -280,7 +280,8 @@

    /**
     * Returns the "timelimit" boolean argument. <br>
     * <i> N.B : the 't' short option is also used by targetldif, testonly, trustmanagerproviderdn, stoptime.</i>
     * <i> N.B : the 't' short option is also used by targetldif, testonly, trustmanagerproviderdn, stoptime,
     * start(dateTime).</i>
     *
     * @return The "timelimit" argument.
     * @throws ArgumentException
@@ -294,7 +295,7 @@
    /**
     * Returns the "testonly" boolean argument.
     * <br><i> N.B : the 't' short option is also used by targetldif, timelimit,
     * trustmanagerproviderdn, stoptime.</i>
     * trustmanagerproviderdn, stoptime, start(dateTime)</i>
     *
     * @return The "testonly" argument.
     * @throws ArgumentException
@@ -325,7 +326,7 @@
    /**
     * Returns the "trustmanagerproviderdn" string argument.
     * <br><i> N.B : the 't' short option is also used by targetldif, timelimit,
     * testonly, stoptime.</i>
     * testonly, stoptime, start(dateTime)</i>
     *
     * @return The "trustmanagerproviderdn" argument.
     * @throws ArgumentException
@@ -562,7 +563,7 @@
    /**
     * Returns the "bindDN" string argument. <br/>
     * <i> N.B : the 'D' short option is also used by rootUserDN.</i>
     * 
     *
     * @param defaultBindDN
     *            The default bind DN.
     * @return The "bindDN" argument.
@@ -685,7 +686,7 @@
    /**
     * Returns the "sample data" integer argument. <br>
     * <i> N.B : the 'd' short option is also used by backupdirectory, disableservice.</i>
     * 
     *
     * @return The "sampleData" argument.
     * @throws ArgumentException
     *             If there is a problem with any of the parameters used to create this argument.
@@ -883,7 +884,7 @@

    /**
     * Returns the "stopTime" string argument. <br><i> N.B : the 't' short option is also used by targetldif, timelimit,
     * testonly, trustmanagerproviderdn.</i>
     * testonly, trustmanagerproviderdn, start(dateTime)</i>
     *
     * @return The "stopTime" argument.
     * @throws ArgumentException