/*
 * Copyright 2015-2019 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.integration.scheduling;

import org.springframework.jmx.export.annotation.ManagedOperation;
import org.springframework.jmx.export.annotation.ManagedResource;

/**
 * A simple {@link PollSkipStrategy} to be used with a {@code PollSkipAdvice}.
 * Invoke {@link #skipPolls()} to start skipping polls; invoke {@link #reset()}
 * to resume polling.
 *
 * @author Gary Russell
 * @since 4.2.5
 *
 */
@ManagedResource
public class SimplePollSkipStrategy implements PollSkipStrategy {

	private volatile boolean skip;

	@Override
	public boolean skipPoll() {
		return this.skip;
	}

	/**
	 * Skip future polls.
	 */
	@ManagedOperation
	public void skipPolls() {
		this.skip = true;
	}

	/**
	 * Resume polling at the next {@code Trigger} event.
	 */
	@ManagedOperation
	public void reset() {
		this.skip = false;
	}

}
