MockRelay.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.mock;

import org.strongback.annotation.ThreadSafe;
import org.strongback.components.Compass;
import org.strongback.components.Relay;

/**
 * A {@link Compass} implementation useful for testing, where the direction can be explicitly set in the test case so that the
 * known value is read by the component that uses an {@link Compass}.
 *
 * @author Randall Hauch
 */
@ThreadSafe
public class MockRelay implements Relay {

    private State state;

    @Override
    public MockRelay off() {
        state = State.OFF;
        return this;
    }

    @Override
    public MockRelay on() {
        state = State.ON;
        return this;
    }

    /**
     * Set the state of this relay to {@link org.strongback.components.Relay.State#SWITCHING_OFF}.
     * @return this instance to enable chaining methods; never null
     */
    public MockRelay switchingOff() {
        state = State.SWITCHING_OFF;
        return this;
    }

    /**
     * Set the state of this relay to {@link org.strongback.components.Relay.State#SWITCHING_ON}.
     * @return this instance to enable chaining methods; never null
     */
    public MockRelay switchingOn() {
        state = State.SWITCHING_ON;
        return this;
    }

    @Override
    public State state() {
        return state;
    }

    @Override
    public String toString() {
        return state().name();
    }
}