001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2013-2014 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.types;
028    
029    import java.io.BufferedReader;
030    
031    /**
032     * Returns the result of a command line utility.
033     */
034    public interface ToolResult
035    {
036      /**
037       * Returns the return code of the command.  See the command line help for the
038       * individual commands to see how to interpret the return codes.
039       *
040       * @return  The return code of the command execution.
041       */
042      int getReturnCode();
043    
044    
045    
046      /**
047       * Returns what the command wrote to stdout as a String.
048       *
049       * @return  What the command wrote to stdout as a String.
050       */
051      String getStdoutAsString();
052    
053    
054    
055      /**
056       * Returns what the command wrote to stdout as a BufferedReader.
057       *
058       * @return  What the command wrote to stdout as a BufferedReader.
059       */
060      BufferedReader getStdoutAsReader();
061    
062    
063    
064      /**
065       * Returns what the command wrote to stderr as a String.
066       *
067       * @return  What the command wrote to stderr as a String.
068       */
069      String getStderrAsString();
070    
071    
072    
073      /**
074       * Returns what the command wrote to stderr as a BufferedReader.
075       *
076       * @return  What the command wrote to stderr as a BufferedReader.
077       */
078      BufferedReader getStderrAsReader();
079    }