com.gemstone.gemfire.management.cli.Result Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
There is a newer version: 2.0-BETA
/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You
 * may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.management.cli;

import java.io.IOException;

/**
 * The result of processing a GemFire Command Line Interface (CLI) command
 * string.
 * 
 * A string representation of this Result can be iterated over using the methods
 * {@link #hasNextLine()}, {@link #nextLine()} and {@link #resetToFirstLine()}.
 * 
 * A Result may have one or more files as part of the command output and if so
 * they can be saved to the file system using {@link #saveIncomingFiles(String)}.
 * To check whether the result has a file in it use
 * {@link #hasIncomingFiles()}.
 * 
 * @author Kirk Lund
 * @author Abhishek Chaudhari
 * 
 * @since 7.0
 */
public interface Result {
  
  /**
   * Indicates a Results status.
   * 
   * @author Kirk Lund
   * @since 7.0
   */
  public enum Status {
    /**
     * Indicates that the command completed successfully.
     */
    OK(0),
    
    /**
     * Indicates that an error occurred while processing the command.
     */
    ERROR(-1);
    
    private final int code;

    private Status(int code) {
      this.code = code;
    }

    /**
     * Returns the code associated with this state.
     */
    public int getCode() {
      return this.code;
    }
  }

  /**
   * Returns the status of a processed command.
   */
  public Status getStatus();
  
  /**
   * Resets the pointer to the first line in the Result.
   */
  public void resetToFirstLine();

  /**
   * Returns whether the result has any more lines of information.
   * 
   * @return True if there are more lines, false otherwise.
   */
  public boolean hasNextLine();

  /**
   * Returns the next line of information from the Result.
   * 
   * @throws IndexOutOfBoundsException
   *           if this method is called more times than there are lines of
   *           information.
   */
  public String nextLine();
  
  /**
   * Returns whether this Result has a file as a part of the command output.
   * 
   * @return True if there is a file, false otherwise.
   */
  public boolean hasIncomingFiles();
  
  /**
   * Save the file(s) from this Result. {@link #hasIncomingFiles()} should be used
   * before calling this method to verify that the Result contains a file.
   * 
   * @param directory
   *          Directory to which the file(s) should be saved.
   * @throws IOException
   *           If an error occurs while saving the file.
   * @throws RuntimeException
   *           If there is no file in the Result to save.
   */
  public void saveIncomingFiles(String directory) throws IOException;
}