Same on LanguageVersionHandler

This commit is contained in:
Clément Fournier
2018-12-03 13:23:36 +01:00
parent 17954f13e9
commit ad8e9ec26b

View File

@ -6,6 +6,7 @@ package net.sourceforge.pmd.lang;
import java.io.Writer;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.lang.dfa.DFAGraphRule;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
@ -13,6 +14,10 @@ import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
* Interface for obtaining the classes necessary for checking source files of a
* specific language.
*
* Note: "façade" getters like {@link #getSymbolFacade()} will be removed with 7.0.0
* and replaced with a more extensible mechanism. They're now deprecated. See also
* https://github.com/pmd/pmd/pull/1426
*
* @author pieter_van_raemdonck - Application Engineers NV/SA - www.ae.be
*/
public interface LanguageVersionHandler {
@ -50,14 +55,18 @@ public interface LanguageVersionHandler {
* Get the DataFlowFacade.
*
* @return VisitorStarter
* @deprecated see note in the class description
*/
@Deprecated
VisitorStarter getDataFlowFacade();
/**
* Get the SymbolFacade.
*
* @return VisitorStarter
* @deprecated see note in the class description
*/
@Deprecated
VisitorStarter getSymbolFacade();
/**
@ -66,7 +75,9 @@ public interface LanguageVersionHandler {
* @param classLoader
* A ClassLoader to use for resolving Types.
* @return VisitorStarter
* @deprecated see note in the class description
*/
@Deprecated
VisitorStarter getSymbolFacade(ClassLoader classLoader);
/**
@ -75,7 +86,9 @@ public interface LanguageVersionHandler {
* @param classLoader
* A ClassLoader to use for resolving Types.
* @return VisitorStarter
* @deprecated see note in the class description
*/
@Deprecated
VisitorStarter getTypeResolutionFacade(ClassLoader classLoader);
/**
@ -84,7 +97,9 @@ public interface LanguageVersionHandler {
* @param writer
* The writer to dump to.
* @return VisitorStarter
* @deprecated The dump façade is not that useful and will be completely scrapped with PMD 7.0.0
*/
@Deprecated
VisitorStarter getDumpFacade(Writer writer, String prefix, boolean recurse);
@ -92,7 +107,9 @@ public interface LanguageVersionHandler {
* Gets the visitor that performs multifile data gathering.
*
* @return The visitor starter
* @deprecated see note in the class description
*/
@Deprecated
VisitorStarter getMultifileFacade();
@ -103,7 +120,9 @@ public interface LanguageVersionHandler {
* @param classLoader The classloader to use to resolve the types of type qualified names
*
* @return The visitor starter
* @deprecated see note in the class description
*/
@Deprecated
VisitorStarter getQualifiedNameResolutionFacade(ClassLoader classLoader);