com.github.fracpete.wekavirtualenv.gui.action.AbstractEnvironmentAction Maven / Gradle / Ivy

Go to download
/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 * AbstractEnvironmentAction.java
 * Copyright (C) 2017 University of Waikato, Hamilton, NZ
 */

package com.github.fracpete.wekavirtualenv.gui.action;

import com.github.fracpete.wekavirtualenv.env.Environment;
import nz.ac.waikato.cms.locator.ClassLocator;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Ancestor for actions that work on an environment.
 *
 * @author FracPete (fracpete at waikato dot ac dot nz)
 */
public abstract class AbstractEnvironmentAction
  extends AbstractAction {

  /** the environment. */
  protected Environment m_Environment;

  /**
   * Sets the environment to use.
   *
   * @param value	the environment
   */
  public void setEnvironment(Environment value) {
    m_Environment = value;
  }

  /**
   * Returns the environment in use.
   *
   * @return		the environment, null if none set
   */
  public Environment getEnvironment() {
    return m_Environment;
  }

  /**
   * Hook method for checking before executing the action.
   *
   * @return		null if successful, otherwise error message
   */
  @Override
  protected String check() {
    String	result;

    result = super.check();

    if (result == null) {
      if (m_Environment == null)
        result = "No environment provided!";
    }

    return result;
  }

  /**
   * Lists all available environment actions.
   *
   * @return		the actions
   */
  public static List getAbstractEnvironmentActions() {
    List	result;
    List				classes;
    AbstractEnvironmentAction 		action;

    result = new ArrayList<>();
    classes = ClassLocator.getSingleton().findClasses(
      AbstractEnvironmentAction.class,
      new String[]{AbstractEnvironmentAction.class.getPackage().getName()});

    for (Class cls: classes) {
      try {
        action = (AbstractEnvironmentAction) cls.newInstance();
        result.add(action);
      }
      catch (Exception e) {
        // ignored
      }
    }

    Collections.sort(result);

    return result;
  }
}