SpeedController.java

/*
 * Strongback
 * Copyright 2015, Strongback and individual contributors by the @authors tag.
 * See the COPYRIGHT.txt in the distribution for a full listing of individual
 * contributors.
 *
 * Licensed under the MIT License; you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://opensource.org/licenses/MIT
 * 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.strongback.components;

import org.strongback.annotation.ThreadSafe;

/**
 * A component that can report and control the speed.
 *
 * @author Randall Hauch
 */
@ThreadSafe
@FunctionalInterface
public interface SpeedController {

    /**
     * Sets the speed.
     *
     * @param speed the new speed as a double
     * @return this object to allow chaining of methods; never null
     */
    public SpeedController setSpeed(double speed);

}