001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.functor.core.algorithm;
018
019import org.apache.commons.functor.Predicate;
020import org.apache.commons.functor.Procedure;
021
022/**
023 * Until-do algorithm (test before).
024 *
025 * @version $Revision: 1344796 $ $Date: 2012-05-31 12:12:39 -0400 (Thu, 31 May 2012) $
026 */
027public class UntilDo extends PredicatedLoop {
028
029    /**
030     * serialVersionUID declaration.
031     */
032    private static final long serialVersionUID = 5096382396346484750L;
033
034    /**
035     * Create a new UntilDo.
036     * @param test whether to keep going
037     * @param body to execute
038     */
039    public UntilDo(Predicate test, Procedure body) {
040        super(body, test);
041    }
042
043    /**
044     * {@inheritDoc}
045     */
046    public final void run() {
047        while (!getTest().test()) {
048            getBody().run();
049        }
050    }
051
052    /**
053     * {@inheritDoc}
054     */
055    @Override
056    public String toString() {
057        return "UntilDo<" + getTest() + "," + getBody() + ">";
058    }
059}