com.clarkparsia.pellint.lintpattern.LintPattern Maven / Gradle / Ivy

Go to download
// Copyright (c) 2006 - 2008, Clark & Parsia, LLC. 
// This source code is available under the terms of the Affero General Public License v3.
//
// Please see LICENSE.txt for full license terms, including the availability of proprietary exceptions.
// Questions, comments, or requests for clarification: [email protected]

package com.clarkparsia.pellint.lintpattern;

import com.clarkparsia.pellint.format.LintFormat;
import com.clarkparsia.pellint.model.LintFixer;


/**
 * 
 * Title: Lint Pattern Interface
 * 
 * 
 * Description: The root interface for all lint patterns which provides some basic presentation interfaces.
 * 
 * 
 * Copyright: Copyright (c) 2008
 * 
 * 
 * Company: Clark & Parsia, LLC. 
 * 
 * 
 * @author Harris Lin
 */
public interface LintPattern {
	
	/**
	 * @return The name of the pattern.
	 */
	String getName();

	/**
	 * @return The detailed description of the pattern.
	 */
	String getDescription();

	/**
	 * Returns true if this pattern provides an automatic fix for every {@link com.clarkparsia.pellint.model.Lint} it matches.
	 * An automatic fix for every {@link com.clarkparsia.pellint.model.Lint} can be made available by calling {@link com.clarkparsia.pellint.model.Lint#setLintFixer(LintFixer)}.
	 * 
	 * @return true if this pattern provides an automatic fix for every {@link com.clarkparsia.pellint.model.Lint} it matches.
	 * 
	 * @see com.clarkparsia.pellint.model.Lint#setLintFixer(LintFixer)
	 */
	boolean isFixable();
	
	/**
	 * @return The default {@link LintFormat} for this pattern. 
	 * 
	 * @see LintFormat
	 */
	LintFormat getDefaultLintFormat();
}