AbstractFix.java

/*******************************************************************************
 * Copyright (c) 2015 - 2016
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *******************************************************************************/
package jsettlers.mapcreator.mapvalidator.result.fix;

import javax.swing.JPopupMenu;

/**
 * Interface to fix found errors
 * 
 * @author Andreas Butti
 *
 */
public abstract class AbstractFix {

	/**
	 * Fix data helper
	 */
	protected FixData data;

	/**
	 * Constructor
	 */
	public AbstractFix() {
	}

	/**
	 * @param data
	 *            Fix data helper
	 */
	public void setData(FixData data) {
		this.data = data;
	}

	/**
	 * Automatically fix the error, if clear what to do
	 */
	public void autoFix() {
	}

	/**
	 * @return true to show the fix menu
	 */
	public abstract boolean isFixAvailable();

	/**
	 * @return Popup Menu
	 */
	public abstract JPopupMenu getPopupMenu();

}