View Javadoc

1   /****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  package org.apache.jsieve;
21  
22  import org.apache.jsieve.exception.SieveException;
23  import org.apache.jsieve.mail.MailAdapter;
24  
25  /**
26   * Interface ExecutableCommand defines the method signatures for Sieve Commands.
27   */
28  public interface ExecutableCommand {
29      /**
30       * Method execute executes a Sieve Command.
31       * 
32       * @param mail -
33       *            The mail against which the Command is executed.
34       * @param arguments -
35       *            The Command arguments
36       * @param block -
37       *            An optional Block to be evaluated
38       * @param context
39       *            <code>SieveContext</code> containing contextual information,
40       *            not null
41       * @return Object - The result of evaluating the Command
42       * @throws SieveException
43       */
44      public Object execute(MailAdapter mail, Arguments arguments, Block block,
45              SieveContext context) throws SieveException;
46  
47  }