LDIFSearch (UnboundID LDAP SDK for Java 7.0.0)

java.lang.Object
- com.unboundid.util.CommandLineTool
- - com.unboundid.ldif.LDIFSearch

```
@ThreadSafety(level=NOT_THREADSAFE)
public final class LDIFSearch
extends CommandLineTool
```
This class provides a command-line tool that can be used to search for entries matching a given set of criteria in an LDIF file.

Constructor Summary

Constructors
Constructor and Description
`LDIFSearch(java.io.OutputStream out, java.io.OutputStream err)` Creates a new instance of this tool with the provided output and error streams.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToolArguments(ArgumentParser parser)` Adds the command-line arguments supported for use with this tool to the provided argument parser.
`boolean`	`defaultsToInteractiveMode()` Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments.
`void`	`doExtendedArgumentValidation()` Performs any necessary processing that should be done to ensure that the provided set of command-line arguments were valid.
`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.
`int`	`getMaxTrailingArguments()` Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool.
`int`	`getMinTrailingArguments()` Retrieves the minimum number of unnamed trailing arguments that must be provided for this tool.
`protected java.lang.String`	`getToolCompletionMessage()` Retrieves an optional message that may provide additional information about the way that the tool completed its processing.
`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 a version string for this tool, if available.
`java.lang.String`	`getTrailingArgumentsPlaceholder()` Retrieves a placeholder string that should be used for trailing arguments in the usage information for this tool.
`static ResultCode`	`main(java.io.OutputStream out, java.io.OutputStream err, java.lang.String... args)` Invokes this tool with the provided set of command-line arguments, using the given output and error streams.
`static void`	`main(java.lang.String... args)` Invokes this tool with the provided set of command-line arguments.
`boolean`	`supportsInteractiveMode()` Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line.
`boolean`	`supportsPropertiesFile()` Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.

Methods inherited from class com.unboundid.util.CommandLineTool
addEnableSSLDebuggingArgument, createArgumentParser, doShutdownHookProcessing, err, getAdditionalDescriptionParagraphs, getErr, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, logToolInvocationByDefault, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, supportsOutputFile, wrapErr, wrapOut

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LDIFSearch
```
public LDIFSearch(@Nullable
                  java.io.OutputStream out,
                  @Nullable
                  java.io.OutputStream err)
```
    Creates a new instance of this tool with the provided output and error streams.
    
    Parameters:
    
    out - The output stream to use for standard output. It may be null if standard output should be suppressed.
    
    err - The output stream to use for standard error. It may be null if standard error should be suppressed.
- Method Detail
  - main
```
public static void main(@NotNull
                        java.lang.String... args)
```
    Invokes this tool with the provided set of command-line arguments.
    
    Parameters:
    
    args - The set of arguments provided to this tool. It may be empty but must not be null.
  - main
```
@NotNull
public static ResultCode main(@Nullable
                                       java.io.OutputStream out,
                                       @Nullable
                                       java.io.OutputStream err,
                                       @NotNull
                                       java.lang.String... args)
```
    Invokes this tool with the provided set of command-line arguments, using the given output and error streams.
    
    Parameters:
    
    out - The output stream to use for standard output. It may be null if standard output should be suppressed.
    
    err - The output stream to use for standard error. It may be null if standard error should be suppressed.
    
    args - The set of arguments provided to this tool. It may be empty but must not be null.
    
    Returns:
    
    A result code indicating the status of processing. Any result code other than ResultCode.SUCCESS should be considered an error.
  - getToolName
```
@NotNull
public java.lang.String getToolName()
```
    Retrieves the name of this tool. It should be the name of the command used to invoke this tool.
    
    Specified by:
    
    getToolName in class CommandLineTool
    
    Returns:
    
    The name for this tool.
  - getToolDescription
```
@NotNull
public java.lang.String getToolDescription()
```
    Retrieves a human-readable description for this tool. If the description should include multiple paragraphs, then this method should return the text for the first paragraph, and the CommandLineTool.getAdditionalDescriptionParagraphs() method should be used to return the text for the subsequent paragraphs.
    
    Specified by:
    
    getToolDescription in class CommandLineTool
    
    Returns:
    
    A human-readable description for this tool.
  - getToolVersion
```
@NotNull
public java.lang.String getToolVersion()
```
    Retrieves a version string for this tool, if available.
    
    Overrides:
    
    getToolVersion in class CommandLineTool
    
    Returns:
    
    A version string for this tool, or null if none is available.
  - getMinTrailingArguments
```
public int getMinTrailingArguments()
```
    Retrieves the minimum number of unnamed trailing arguments that must be provided for this tool. If a tool requires the use of trailing arguments, then it must override this method and the CommandLineTool.getMaxTrailingArguments() arguments to return nonzero values, and it must also override the CommandLineTool.getTrailingArgumentsPlaceholder() method to return a non-null value.
    
    Overrides:
    
    getMinTrailingArguments in class CommandLineTool
    
    Returns:
    
    The minimum number of unnamed trailing arguments that may be provided for this tool. A value of zero indicates that the tool may be invoked without any trailing arguments.
  - getMaxTrailingArguments
```
public int getMaxTrailingArguments()
```
    Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool. If a tool supports trailing arguments, then it must override this method to return a nonzero value, and must also override the CommandLineTool.getTrailingArgumentsPlaceholder() method to return a non-null value.
    
    Overrides:
    
    getMaxTrailingArguments in class CommandLineTool
    
    Returns:
    
    The maximum number of unnamed trailing arguments that may be provided for this tool. A value of zero indicates that trailing arguments are not allowed. A negative value indicates that there should be no limit on the number of trailing arguments.
  - getTrailingArgumentsPlaceholder
```
@NotNull
public java.lang.String getTrailingArgumentsPlaceholder()
```
    Retrieves a placeholder string that should be used for trailing arguments in the usage information for this tool.
    
    Overrides:
    
    getTrailingArgumentsPlaceholder in class CommandLineTool
    
    Returns:
    
    A placeholder string that should be used for trailing arguments in the usage information for this tool, or null if trailing arguments are not supported.
  - supportsInteractiveMode
```
public boolean supportsInteractiveMode()
```
    Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line. If interactive mode is supported, it may be invoked using the "--interactive" argument. Alternately, if interactive mode is supported and CommandLineTool.defaultsToInteractiveMode() returns true, then interactive mode may be invoked by simply launching the tool without any arguments.
    
    Overrides:
    
    supportsInteractiveMode in class CommandLineTool
    
    Returns:
    
    true if this tool supports interactive mode, or false if not.
  - defaultsToInteractiveMode
```
public boolean defaultsToInteractiveMode()
```
    Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments. This will only be used if CommandLineTool.supportsInteractiveMode() returns true.
    
    Overrides:
    
    defaultsToInteractiveMode in class CommandLineTool
    
    Returns:
    
    true if this tool defaults to using interactive mode if launched without any command-line arguments, or false if not.
  - supportsPropertiesFile
```
public boolean supportsPropertiesFile()
```
    Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.
    
    Overrides:
    
    supportsPropertiesFile in class CommandLineTool
    
    Returns:
    
    true if this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line, or false if not.
  - getToolCompletionMessage
```
@Nullable
protected java.lang.String getToolCompletionMessage()
```
    Retrieves an optional message that may provide additional information about the way that the tool completed its processing. For example if the tool exited with an error message, it may be useful for this method to return that error message.
    
    The message returned by this method is intended for informational purposes and is not meant to be parsed or programmatically interpreted.
    
    Overrides:
    
    getToolCompletionMessage in class CommandLineTool
    
    Returns:
    
    An optional message that may provide additional information about the completion state for this tool, or null if no completion message is available.
  - addToolArguments
```
public void addToolArguments(@NotNull
                             ArgumentParser parser)
                      throws ArgumentException
```
    Adds the command-line arguments supported for use with this tool to the provided argument parser. The tool may need to retain references to the arguments (and/or the argument parser, if trailing arguments are allowed) to it in order to obtain their values for use in later processing.
    
    Specified by:
    
    addToolArguments in class CommandLineTool
    
    Parameters:
    
    parser - The argument parser to which the arguments are to be added.
    
    Throws:
    
    ArgumentException - If a problem occurs while adding any of the tool-specific arguments to the provided argument parser.
  - doExtendedArgumentValidation
```
public void doExtendedArgumentValidation()
                                  throws ArgumentException
```
    Performs any necessary processing that should be done to ensure that the provided set of command-line arguments were valid. This method will be called after the basic argument parsing has been performed and immediately before the CommandLineTool.doToolProcessing() method is invoked. Note that if the tool supports interactive mode, then this method may be invoked multiple times to allow the user to interactively fix validation errors.
    
    Overrides:
    
    doExtendedArgumentValidation in class CommandLineTool
    
    Throws:
    
    ArgumentException - If there was a problem with the command-line arguments provided to this program.
  - doToolProcessing
```
@NotNull
public ResultCode doToolProcessing()
```
    Performs the core set of processing for this tool.
    
    Specified by:
    
    doToolProcessing in class CommandLineTool
    
    Returns:
    
    A result code that indicates whether the processing completed successfully.
  - getExampleUsages
```
@NotNull
public java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()
```
    Retrieves a set of information that may be used to generate example usage information. Each element in the returned map should consist of a map between an example set of arguments and a string that describes the behavior of the tool when invoked with that set of arguments.
    
    Overrides:
    
    getExampleUsages in class CommandLineTool
    
    Returns:
    
    A set of information that may be used to generate example usage information. It may be null or empty if no example usage information is available.

Class LDIFSearch

Constructor Summary

Method Summary

Methods inherited from class com.unboundid.util.CommandLineTool

Methods inherited from class java.lang.Object

Constructor Detail

LDIFSearch

Method Detail

main

main

getToolName

getToolDescription

getToolVersion

getMinTrailingArguments

getMaxTrailingArguments

getTrailingArgumentsPlaceholder

supportsInteractiveMode

defaultsToInteractiveMode

supportsPropertiesFile

getToolCompletionMessage

addToolArguments

doExtendedArgumentValidation

doToolProcessing

getExampleUsages