trunk/main/src/main/java/org/apache/jsieve/tests/ExecutableTest.java

/****************************************************************
 * 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.                                           *
 ****************************************************************/

package org.apache.jsieve.tests;

import org.apache.jsieve.Arguments;
import org.apache.jsieve.SieveContext;
import org.apache.jsieve.exception.SieveException;
import org.apache.jsieve.mail.MailAdapter;

/**
 * Interface ExecutableTest defines the method signatures for a Sieve Test.
 */
public interface ExecutableTest {
    /**
     * Method execute executes a Test and answers a boolean indicating if the
     * test was passed.
     * 
     * @param mail
     * @param arguments
     * @param context
     *            <code>SieveContext</code> giving contextual information, not
     *            null
     * @return boolean
     * @throws SieveException
     */
    public boolean execute(MailAdapter mail, Arguments arguments,
            SieveContext context) throws SieveException;

}