com.cedarsoft.swing.action.ApplicationAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of actions Show documentation
There is a newer version: 8.1.1
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.swing.action;


import javax.annotation.Nonnull;

import javax.swing.AbstractAction;
import java.awt.event.ActionEvent;

/**
 * Base class for application actions.
 *
 * @author Johannes Schneider ([email protected])
 */
public abstract class ApplicationAction extends AbstractAction {
  /**
   * Constructor for ApplicationAction.
   *
   * @param name a {@link String} object.
   */
  protected ApplicationAction( @Nonnull String name ) {
    super( name );
  }

  /**
   * {@inheritDoc}
   * 
   * Default implementation that delegates to {@link #applicationActionPerformed(ActionEvent)}.
   */
  @Override
  public final void actionPerformed( @Nonnull ActionEvent e ) {
    try {
      applicationActionPerformed( e );
    } catch ( ApplicationException exception ) {
      handleApplicationException( exception );
    }
  }

  /**
   * 
handleApplicationException
   *
   * @param exception a {@link ApplicationException} object.
   */
  protected abstract void handleApplicationException( @Nonnull ApplicationException exception );

  /**
   * Should be overridden by subclasses.
   * Implementations may throw an ApplicationException if an expected exception occurred
   *
   * @param e the action event
   * @throws ApplicationException if an application error occured
   */
  public abstract void applicationActionPerformed( @Nonnull ActionEvent e ) throws ApplicationException;
}