package org.apache.turbine.modules;

 /*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you 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.

  */

 import org.apache.turbine.pipeline.PipelineData;

 /**

  * Generic Action interface.

  *

  * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>

  * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>

  * @version $Id: Action.java 1854786 2019-03-04 18:29:18Z tv $

  */

 @FunctionalInterface

 public interface Action extends Assembler

 {

     /** Prefix for action related classes and templates */

     String PREFIX = "actions";

     /** Property for the size of the module cache if caching is on */

     String CACHE_SIZE_KEY = "action.cache.size";

     /** The default size for the action cache */

     int CACHE_SIZE_DEFAULT = 20;

     /** Represents Action Objects */

     String NAME = "action";

     /**

      * A subclass must implement this method to perform itself.  The

      * Action can also set the screen that is associated with {@link PipelineData}.

      *

      * @param pipelineData Turbine information.

      * @throws Exception a generic exception.

      */

     void doPerform(PipelineData pipelineData) throws Exception;

     /**

      * Subclasses can override this method to add additional

      * functionality.

      *

      * @param pipelineData Turbine information.

      * @throws Exception a generic exception.

      */

     default void perform(PipelineData pipelineData) throws Exception

     {

         doPerform(pipelineData);

     }

 }