Package com.unboundid.ldap.sdk.examples

Class IndentLDAPFilter

    • Constructor Detail

      • IndentLDAPFilter

        public IndentLDAPFilter​(@Nullable
                        java.io.OutputStream out,
                        @Nullable
                        java.io.OutputStream err)
        Creates a new instance of this command-line tool with the provided output and error streams.
        Parameters:
        out - The output stream to which standard out should be written. It may be null if standard output should be suppressed.
        err - The output stream to which standard error should be written. It may be null if standard error should be suppressed.

    • Method Detail

      • main

        public static void main​(@NotNull
                        java.lang.String... args)
        Runs this tool with the provided set of command-line arguments.
        Parameters:
        args - The command line arguments provided to this program.

      • main

        @NotNull
public static ResultCode main​(@Nullable
                              java.io.OutputStream out,
                              @Nullable
                              java.io.OutputStream err,
                              @NotNull
                              java.lang.String... args)
        Runs this tool with the provided set of command-line arguments.
        Parameters:
        out - The output stream to which standard out should be written. It may be null if standard output should be suppressed.
        err - The output stream to which standard error should be written. It may be null if standard error should be suppressed.
        args - The command line arguments provided to this program.
        Returns:
        A result code that indicates whether processing was successful. 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.

      • 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 getMaxTrailingArguments() arguments to return nonzero values, and it must also override the 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 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 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.

      • supportsOutputFile

        protected boolean supportsOutputFile()
        Indicates whether this tool should provide arguments for redirecting output to a file. If this method returns true, then the tool will offer an "--outputFile" argument that will specify the path to a file to which all standard output and standard error content will be written, and it will also offer a "--teeToStandardOut" argument that can only be used if the "--outputFile" argument is present and will cause all output to be written to both the specified output file and to standard output.
        Overrides:
        supportsOutputFile in class CommandLineTool
        Returns:
        true if this tool should provide arguments for redirecting output to a file, or false if not.

      • 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.

      • indentLDAPFilter

        public static void indentLDAPFilter​(@NotNull
                                    Filter filter,
                                    @NotNull
                                    java.lang.String currentIndentString,
                                    @NotNull
                                    java.lang.String indentSpaces,
                                    @NotNull
                                    java.util.List<java.lang.String> indentedFilterLines)
        Generates an indented representation of the provided filter.
        Parameters:
        filter - The filter to be indented. It must not be null.
        currentIndentString - A string that represents the current indent that should be added before each line of the filter. It may be empty, but must not be null.
        indentSpaces - A string that represents the number of additional spaces that each subsequent level of the hierarchy should be indented. It may be empty, but must not be null.
        indentedFilterLines - A list to which the lines that comprise the indented filter should be added. It must not be null, and must be updatable.

      • 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.