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.NullaryPredicate;
020import org.apache.commons.functor.NullaryProcedure;
021
022/**
023 * Until-do algorithm (test before).
024 *
025 * @version $Revision: 1537906 $ $Date: 2013-11-01 12:47:33 +0100 (Fr, 01 Nov 2013) $
026 */
027public class UntilDo extends PredicatedLoop {
028
029    /**
030     * Create a new UntilDo.
031     * @param test whether to keep going
032     * @param body to execute
033     */
034    public UntilDo(NullaryPredicate test, NullaryProcedure body) {
035        super(body, test);
036    }
037
038    /**
039     * {@inheritDoc}
040     */
041    public final void run() {
042        while (!getTest().test()) {
043            getBody().run();
044        }
045    }
046
047    /**
048     * {@inheritDoc}
049     */
050    @Override
051    public String toString() {
052        return "UntilDo<" + getTest() + "," + getBody() + ">";
053    }
054}