ToggleCommandStateAccessor.java

/******************************************************************************
 * Copyright (C) 2014 Yevgeny Krasik                                          *
 *                                                                            *
 * Licensed 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 com.github.ykrasik.jaci.api;

/**
 * Accesses the boolean state of a component for a {@link ToggleCommand}.
 *
 * @author Yevgeny Krasik
 */
public interface ToggleCommandStateAccessor {
    /**
     * Set the state of the component.
     *
     * @param value Value to set the component to.
     */
    void set(boolean value);

    /**
     * @return Current value of the component. It is expected that this call will not change the state of the component.
     */
    boolean get();
}