hooks-its/src/main/java/com/googlesource/gerrit/plugins/hooks/workflow/ActionRequest.java

// Copyright (C) 2013 The Android Open Source Project
//
// 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.

package com.googlesource.gerrit.plugins.hooks.workflow;

import java.util.Arrays;

import com.google.inject.Inject;
import com.google.inject.assistedinject.Assisted;
import com.google.gerrit.common.Nullable;

/**
 * An action to take for an {@code ChangeEvent}.
 *
 * Actions are typically related to an Its (e.g.:adding an Its comment, or
 * changing an issue's status).
 */
public class ActionRequest {
  private final String unparsed;
  private final String[] chopped;

  public interface Factory {
    ActionRequest create(String specification);
  }

  @Inject
  public ActionRequest(@Nullable @Assisted String specification) {
    if (specification == null) {
      this.unparsed = "";
    } else {
      this.unparsed = specification;
    }
    this.chopped = unparsed.split(" ");
  }

  /**
   * Gets the name of the requested action.
   *
   * @return The name of the requested action, if a name has been given.
   *    "" otherwise.
   */
  public String getName() {
    String ret = "";
    if (chopped.length > 0) {
      ret = chopped[0];
    }
    return ret;
  }

  /**
   * Gets the name of the requested action.
   *
   * @param i The number of the parameter to extract. 1 is the first parameter.
   * @return The name of the requested parameter, if the requested parameter
   *    exists. "" otherwise.
   */
  public String getParameter(int i) {
    String ret = "";
    if (chopped.length > i) {
      ret = chopped[i];
    }
    return ret;
  }

  /**
   * Gets the parameters of the requested action.
   *
   * @return The parameters of the requested action.
   */
  public String[] getParameters() {
    return Arrays.copyOfRange(chopped, 1, chopped.length);
  }

  /**
   * Gets the unparsed specification of this action request.
   *
   * @return The unparsed action request.
   */
  public String getUnparsed() {
    return unparsed;
  }

  @Override
  public String toString() {
    return getUnparsed();
  }
}