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

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

The newest version!

/*
 * 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.util.Map;

/**
 * Represents GemFire Command Line Interface (CLI) command strings. A
 * CommandStatement instance can be used multiple times to process
 * the same command string repeatedly.
 * 
 * @author Kirk Lund
 * @author Abhishek Chaudhari
 * 
 * @since 7.0
 */
public interface CommandStatement {
  
  /**
   * Returns the user specified command string.
   */
  public String getCommandString();
  
  /**
   * Returns the CLI environment variables.
   */
  public Map getEnv();
  
  /**
   * Processes this command statement with the user specified command string
   * and environment
   * 
   * @return The {@link Result} of the execution of this command statement.
   */
  public Result process();
  
  
  /**
   * Returns whether the command statement is well formed.
   * 
   * @return True if the command statement is well formed, false otherwise.
   */
  public boolean validate();
}