trunk/main/src/main/java/org/apache/jsieve/TestList.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;

import java.util.ArrayList;
import java.util.List;

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

/**
 * <p>
 * A parsed representation of an RFC3028 testlist argument...
 * </p>
 * 
 * <code>test-list = "(" test *("," test) ")"</code>
 */
public class TestList implements Executable {
    /**
     * List of Tests
     */
    private List<Test> fieldTests;

    /**
     * Constructor for TestList.
     */
    private TestList() {
        super();
    }

    /**
     * Constructor for TestList.
     * 
     * @param children -
     *            A List of Tests
     */
    public TestList(List<Test> children) {
        this();
        setTests(children);
    }

    /**
     * Constructor for TestList.
     * 
     * @param child -
     *            A Test
     */
    public TestList(Test child) {
        this();
        List<Test> children = new ArrayList<Test>();
        children.add(child);
        setTests(children);
    }

    /**
     * @see org.apache.jsieve.Executable#execute(MailAdapter, SieveContext)
     */
    public Object execute(MailAdapter mail, SieveContext context)
            throws SieveException {
        return new Boolean(allTestsPass(mail, context));
    }

    /**
     * Do all tests pass for the given mail?
     * 
     * @param mail not null
     * @param context not null
     * @return false when any test in the list fails when run against the given mail,
     * true when no tests fail
     * @throws SieveException
     */
    public boolean allTestsPass(MailAdapter mail, SieveContext context) throws SieveException {
        boolean result = true;
        for (Test test:getTests()) {
            result = test.isTestPassed(mail, context);
            if (!result) {
                break;
            }
        }
        return result;
    }

    /**
     * Do any tests pass for the given mail?
     * 
     * @param mail not null
     * @param context not null
     * @return true when any test in this list passes,
     * false otherwise
     * @throws SieveException
     */
    public boolean anyTestsPass(MailAdapter mail, SieveContext context) throws SieveException {
        boolean result = false;
        for (Test test:getTests()) {
            result = test.isTestPassed(mail, context);
            if (result) {
                break;
            }
        }
        return result;
    }
    
    /**
     * Returns the children.
     * 
     * @return List
     */
    public List<Test> getTests() {
        return fieldTests;
    }

    /**
     * Sets the children.
     * 
     * @param children
     *            The children to set
     */
    protected void setTests(List<Test> children) {
        fieldTests = children;
    }

    public String toString() {
        return "TEST LIST: " + fieldTests;
    }

    /**
     * Is this test list empty?
     * @return true when empty,
     * false when tests exist
     */
    public boolean isEmpty() {
        return fieldTests.isEmpty();
    }

}