|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.CommandLineTool
com.unboundid.ldap.sdk.persist.GenerateSchemaFromSource
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class GenerateSchemaFromSource
This class provides a tool which can be used to generate LDAP attribute
type and object class definitions which may be used to store objects
created from a specified Java class. The given class must be included in the
classpath of the JVM used to invoke the tool, and must be marked with the
LDAPObject
annotation.
Constructor Summary | |
---|---|
GenerateSchemaFromSource(java.io.OutputStream outStream,
java.io.OutputStream errStream)
Creates a new instance of this tool. |
Method Summary | |
---|---|
void |
addToolArguments(ArgumentParser parser)
Adds the command-line arguments supported for use with this tool to the provided argument parser. |
ResultCode |
doToolProcessing()
Performs the core set of processing for this tool. |
java.util.LinkedHashMap<java.lang.String[],java.lang.String> |
getExampleUsages()
Retrieves a set of information that may be used to generate example usage information. |
java.lang.String |
getToolDescription()
Retrieves a human-readable description for this tool. |
java.lang.String |
getToolName()
Retrieves the name of this tool. |
java.lang.String |
getToolVersion()
Retrieves the version string for this tool. |
static void |
main(java.lang.String[] args)
Parse the provided command line arguments and perform the appropriate processing. |
static ResultCode |
main(java.lang.String[] args,
java.io.OutputStream outStream,
java.io.OutputStream errStream)
Parse the provided command line arguments and perform the appropriate processing. |
Methods inherited from class com.unboundid.util.CommandLineTool |
---|
createArgumentParser, doExtendedArgumentValidation, doShutdownHookProcessing, err, getErr, getMaxTrailingArguments, getOut, getTrailingArgumentsPlaceholder, out, registerShutdownHook, runTool, wrapErr, wrapOut |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GenerateSchemaFromSource(java.io.OutputStream outStream, java.io.OutputStream errStream)
outStream
- The output stream to which standard out should be
written. It may be null
if output should be
suppressed.errStream
- The output stream to which standard error should be
written. It may be null
if error messages
should be suppressed.Method Detail |
---|
public static void main(java.lang.String[] args)
args
- The command line arguments provided to this program.public static ResultCode main(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream)
args
- The command line arguments provided to this program.outStream
- The output stream to which standard out should be
written. It may be null
if output should be
suppressed.errStream
- The output stream to which standard error should be
written. It may be null
if error messages
should be suppressed.
public java.lang.String getToolName()
getToolName
in class CommandLineTool
public java.lang.String getToolDescription()
getToolDescription
in class CommandLineTool
public java.lang.String getToolVersion()
getToolVersion
in class CommandLineTool
public void addToolArguments(ArgumentParser parser) throws ArgumentException
addToolArguments
in class CommandLineTool
parser
- The argument parser to which the arguments are to be added.
ArgumentException
- If a problem occurs while adding any of the
tool-specific arguments to the provided
argument parser.public ResultCode doToolProcessing()
doToolProcessing
in class CommandLineTool
public java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()
getExampleUsages
in class CommandLineTool
null
or empty if no example usage
information is available.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |