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.tests;
21
22 import org.apache.jsieve.Arguments;
23 import org.apache.jsieve.SieveContext;
24 import org.apache.jsieve.exception.SieveException;
25 import org.apache.jsieve.mail.MailAdapter;
26
27 /**
28 * Interface ExecutableTest defines the method signatures for a Sieve Test.
29 */
30 public interface ExecutableTest {
31 /**
32 * Method execute executes a Test and answers a boolean indicating if the
33 * test was passed.
34 *
35 * @param mail
36 * @param arguments
37 * @param context
38 * <code>SieveContext</code> giving contextual information, not
39 * null
40 * @return boolean
41 * @throws SieveException
42 */
43 public boolean execute(MailAdapter mail, Arguments arguments,
44 SieveContext context) throws SieveException;
45
46 }