PageRegistrationCommand.java

/*
 * Copyright 2008-2010 the T2 Project ant the Others.
 *
 * 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 org.t2framework.confeito.spi;

/**
 * Page registration command for {@link PageRegistrationHandler}.
 * 
 * This enum uses when developer makes own {@link PageRegistrationHandler} to
 * tell the T2 whether registration process go further or stop. T2 framework
 * expects that one or more {@link PageRegistrationHandler} is registered and
 * used at the time of page registration process.
 * 
 * @author shot
 * 
 */
public enum PageRegistrationCommand {
	/**
	 * Tells T2 continue to next {@link PageRegistrationHandler}.
	 */
	CONTINUE,

	/**
	 * Stop page registration process.
	 */
	STOP,

	/**
	 * Fail to registration process.
	 */
	FAIL;
}