org.opends.server.tools

Class JavaPropertiesToolArgumentParser

java.lang.Object

com.forgerock.opendj.cli.ArgumentParser

org.opends.server.tools.JavaPropertiesToolArgumentParser

All Implemented Interfaces:

com.forgerock.opendj.cli.ToolRefDocContainer

public class JavaPropertiesToolArgumentParser
extends com.forgerock.opendj.cli.ArgumentParser

Class used to parse the arguments of the java properties tool command-line.

Field Summary

Fields inherited from class com.forgerock.opendj.cli.ArgumentParser

argumentGroups, DEFAULT_OPENDJ_CONFIG_DIR, DEFAULT_OPENDJ_PROPERTIES_FILE_EXTENSION, DEFAULT_OPENDJ_PROPERTIES_FILE_NAME, ioArgGroup, PROPERTY_SCRIPT_NAME, PROPERTY_SCRIPT_NAME_LEGACY

Constructor Summary

Constructors

Constructor and Description
JavaPropertiesToolArgumentParser(String mainClassName) The default constructor for this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	initializeArguments() Initializes the arguments without parsing them.
void	parseArguments(String[] args)

Methods inherited from class com.forgerock.opendj.cli.ArgumentParser

addArgument, addArgument, addDefaultArgument, addLdapConnectionArgument, displayMessageAndUsageReference, getArgumentForLongID, getArgumentList, getBindPassword, getDocSubcommandsDescriptionSupplement, getDocToolDescriptionSupplement, getHelpUsageReference, getOptionsRefSect1, getShortToolDescription, getTrailingArguments, getUsage, getUsageMessage, isUsageArgumentPresent, isVersionArgumentPresent, parseArguments, parseArguments, setDocSubcommandsDescriptionSupplement, setDocToolDescriptionSupplement, setFilePropertiesArgument, setNoPropertiesFileArgument, setShortToolDescription, setUsageArgument, setUsageArgument, setUsageOrVersionDisplayed, setVersionHandler, usageOrVersionDisplayed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaPropertiesToolArgumentParser

public JavaPropertiesToolArgumentParser(String mainClassName)

The default constructor for this class.

Parameters:

mainClassName - the class name of the main class for the command-line that is being used.

Method Detail

initializeArguments

public void initializeArguments()
                         throws com.forgerock.opendj.cli.ArgumentException

Initializes the arguments without parsing them.

Throws:

com.forgerock.opendj.cli.ArgumentException - if there was an error creating or adding the arguments. If this occurs is likely to be a bug.

parseArguments

public void parseArguments(String[] args)
                    throws com.forgerock.opendj.cli.ArgumentException

Overrides:

parseArguments in class com.forgerock.opendj.cli.ArgumentParser

Throws:

com.forgerock.opendj.cli.ArgumentException