mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
opendj3/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/StringArgument.java
@@ -6,17 +6,16 @@ * (the "License"). You may not use this file except in compliance * with the License. * * You can obtain a copy of the license at * trunk/opendj3/legal-notices/CDDLv1_0.txt * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt * or http://forgerock.org/license/CDDLv1.0.html. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at * trunk/opendj3/legal-notices/CDDLv1_0.txt. If applicable, * add the following below this CDDL HEADER, with the fields enclosed * by brackets "[]" replaced with your own identifying information: * file and include the License file at legal-notices/CDDLv1_0.txt. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: * Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END @@ -26,122 +25,111 @@ */ package com.forgerock.opendj.ldap.tools; import org.forgerock.i18n.LocalizableMessage; import org.forgerock.i18n.LocalizableMessageBuilder; /** * This class defines an argument type that will accept any string value. */ final class StringArgument extends Argument { /** * Creates a new string argument with the provided information. * * @param name * The generic name that should be used to refer to this argument. * @param shortIdentifier * The single-character identifier for this argument, or * <CODE>null</CODE> if there is none. * @param longIdentifier * The long identifier for this argument, or <CODE>null</CODE> if * there is none. * @param isRequired * Indicates whether this argument must be specified on the command * line. * @param isMultiValued * Indicates whether this argument may be specified more than once to * provide multiple values. * @param needsValue * Indicates whether this argument requires a value. * @param valuePlaceholder * The placeholder for the argument value that will be displayed in * usage information, or <CODE>null</CODE> if this argument does not * require a value. * @param defaultValue * The default value that should be used for this argument if none is * provided in a properties file or on the command line. This may be * <CODE>null</CODE> if there is no generic default. * @param propertyName * The name of the property in a property file that may be used to * override the default value but will be overridden by a * command-line argument. * @param description * LocalizableMessage for the description of this argument. * @throws ArgumentException * If there is a problem with any of the parameters used to create * this argument. */ public StringArgument(final String name, final Character shortIdentifier, final String longIdentifier, final boolean isRequired, final boolean isMultiValued, final boolean needsValue, final LocalizableMessage valuePlaceholder, final String defaultValue, final String propertyName, final LocalizableMessage description) throws ArgumentException { super(name, shortIdentifier, longIdentifier, isRequired, isMultiValued, needsValue, valuePlaceholder, defaultValue, propertyName, description); } final class StringArgument extends Argument { /** * Creates a new string argument with the provided information. * * @param name * The generic name that should be used to refer to this * argument. * @param shortIdentifier * The single-character identifier for this argument, or * <CODE>null</CODE> if there is none. * @param longIdentifier * The long identifier for this argument, or <CODE>null</CODE> if * there is none. * @param isRequired * Indicates whether this argument must be specified on the * command line. * @param isMultiValued * Indicates whether this argument may be specified more than * once to provide multiple values. * @param needsValue * Indicates whether this argument requires a value. * @param valuePlaceholder * The placeholder for the argument value that will be displayed * in usage information, or <CODE>null</CODE> if this argument * does not require a value. * @param defaultValue * The default value that should be used for this argument if * none is provided in a properties file or on the command line. * This may be <CODE>null</CODE> if there is no generic default. * @param propertyName * The name of the property in a property file that may be used * to override the default value but will be overridden by a * command-line argument. * @param description * LocalizableMessage for the description of this argument. * @throws ArgumentException * If there is a problem with any of the parameters used to * create this argument. */ public StringArgument(final String name, final Character shortIdentifier, final String longIdentifier, final boolean isRequired, final boolean isMultiValued, final boolean needsValue, final LocalizableMessage valuePlaceholder, final String defaultValue, final String propertyName, final LocalizableMessage description) throws ArgumentException { super(name, shortIdentifier, longIdentifier, isRequired, isMultiValued, needsValue, valuePlaceholder, defaultValue, propertyName, description); } /** * Creates a new string argument with the provided information. * * @param name * The generic name that should be used to refer to this * argument. * @param shortIdentifier * The single-character identifier for this argument, or * <CODE>null</CODE> if there is none. * @param longIdentifier * The long identifier for this argument, or <CODE>null</CODE> if * there is none. * @param isRequired * Indicates whether this argument must be specified on the * command line. * @param needsValue * Indicates whether this argument requires a value. * @param valuePlaceholder * The placeholder for the argument value that will be displayed * in usage information, or <CODE>null</CODE> if this argument * does not require a value. * @param description * LocalizableMessage for the description of this argument. * @throws ArgumentException * If there is a problem with any of the parameters used to * create this argument. */ public StringArgument(final String name, final Character shortIdentifier, final String longIdentifier, final boolean isRequired, final boolean needsValue, final LocalizableMessage valuePlaceholder, final LocalizableMessage description) throws ArgumentException { super(name, shortIdentifier, longIdentifier, isRequired, false, needsValue, valuePlaceholder, null, null, description); } /** * Creates a new string argument with the provided information. * * @param name * The generic name that should be used to refer to this argument. * @param shortIdentifier * The single-character identifier for this argument, or * <CODE>null</CODE> if there is none. * @param longIdentifier * The long identifier for this argument, or <CODE>null</CODE> if * there is none. * @param isRequired * Indicates whether this argument must be specified on the command * line. * @param needsValue * Indicates whether this argument requires a value. * @param valuePlaceholder * The placeholder for the argument value that will be displayed in * usage information, or <CODE>null</CODE> if this argument does not * require a value. * @param description * LocalizableMessage for the description of this argument. * @throws ArgumentException * If there is a problem with any of the parameters used to create * this argument. */ public StringArgument(final String name, final Character shortIdentifier, final String longIdentifier, final boolean isRequired, final boolean needsValue, final LocalizableMessage valuePlaceholder, final LocalizableMessage description) throws ArgumentException { super(name, shortIdentifier, longIdentifier, isRequired, false, needsValue, valuePlaceholder, null, null, description); } /** * Indicates whether the provided value is acceptable for use in this * argument. * * @param valueString * The value for which to make the determination. * @param invalidReason * A buffer into which the invalid reason may be written if the value * is not acceptable. * @return <CODE>true</CODE> if the value is acceptable, or <CODE>false</CODE> * if it is not. */ @Override public boolean valueIsAcceptable(final String valueString, final LocalizableMessageBuilder invalidReason) { // All values will be acceptable for this argument. return true; } /** * Indicates whether the provided value is acceptable for use in this * argument. * * @param valueString * The value for which to make the determination. * @param invalidReason * A buffer into which the invalid reason may be written if the * value is not acceptable. * @return <CODE>true</CODE> if the value is acceptable, or * <CODE>false</CODE> if it is not. */ @Override public boolean valueIsAcceptable(final String valueString, final LocalizableMessageBuilder invalidReason) { // All values will be acceptable for this argument. return true; } }
