Uses of Class
com.puppycrawl.tools.checkstyle.api.CheckstyleException
-
Packages that use CheckstyleException Package Description com.puppycrawl.tools.checkstyle Contains the implementation of the Checkstyle framework.com.puppycrawl.tools.checkstyle.api Contains the core API to be used to implement checks.com.puppycrawl.tools.checkstyle.checks.header File Header checks.com.puppycrawl.tools.checkstyle.checks.imports Contains the Imports checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.javadoc Contains the Javadoc checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.regexp Contains the regular expression checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.filters Contains the filters that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.gui User interface classes for CheckStyle.com.puppycrawl.tools.checkstyle.meta Contains module metadata generation classes for checkstyle.com.puppycrawl.tools.checkstyle.utils Contains utils classes for checkstyle. -
-
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle
Methods in com.puppycrawl.tools.checkstyle that throw CheckstyleException Modifier and Type Method Description private java.lang.Object
PackageObjectFactory. createFromStandardCheckSet(java.lang.String name)
Create object from one of Checkstyle module names.java.lang.Object
ModuleFactory. createModule(java.lang.String name)
Creates a new instance of a class from a given name.java.lang.Object
PackageObjectFactory. createModule(java.lang.String name)
Creates a new instance of a class from a given name, or that name concatenated with "Check".private java.lang.Object
PackageObjectFactory. createModuleByTryInEachPackage(java.lang.String name)
Searching to class with given name (or name concatenated with "Check") in existing packages.private java.lang.Object
PackageObjectFactory. createObject(java.lang.String className)
Creates a new instance of a named class.private java.lang.Object
PackageObjectFactory. createObjectFromFullModuleNames(java.lang.String name, java.util.Set<java.lang.String> fullModuleNames)
Create Object from optional full module names.private java.lang.Object
PackageObjectFactory. createObjectFromMap(java.lang.String name, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> map)
Create object with the help of the supplied map.private static int
Main. execute(picocli.CommandLine.ParseResult parseResult, Main.CliOptions options)
Validates the user input and returns -1 if invalid, otherwise executes CheckStyle and returns the number of violations.protected void
Checker. finishLocalSetup()
private static void
JavadocPropertiesGenerator. formatInlineCodeTag(java.lang.StringBuilder builder, DetailNode inlineTag)
Converts inline code tag into HTML form.java.lang.String
DefaultConfiguration. getAttribute(java.lang.String attributeName)
private static java.lang.String
JavadocPropertiesGenerator. getFirstJavadocSentence(DetailAST ast)
Extracts the first sentence as HTML formatted text from the comment of an DetailAST.private static java.lang.String
JavadocPropertiesGenerator. getFirstJavadocSentence(DetailNode tree)
Extracts the first sentence as HTML formatted text from a DetailNode.static java.util.Set<java.lang.String>
PackageNamesLoader. getPackageNames(java.lang.ClassLoader classLoader)
Returns the set of package names, compiled from all checkstyle_packages.xml files found on the given class loaders classpath.java.lang.String
DefaultConfiguration. getProperty(java.lang.String propertyName)
private static RootModule
Main. getRootModule(java.lang.String name, java.lang.ClassLoader moduleClassLoader)
Creates a new instance of the root module that will control and run Checkstyle.private static void
JavadocPropertiesGenerator. iteratePublicStaticIntFields(DetailAST objBlock, java.util.function.Consumer<java.lang.String> consumer)
Walks over the type members and push the first javadoc sentence of everypublic
static
int
field to the consumer.static Configuration
ConfigurationLoader. loadConfiguration(java.lang.String config, PropertyResolver overridePropsResolver)
Returns the module configurations in a specified file.static Configuration
ConfigurationLoader. loadConfiguration(java.lang.String config, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions)
Returns the module configurations in a specified file.static Configuration
ConfigurationLoader. loadConfiguration(java.lang.String config, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions, ThreadModeSettings threadModeSettings)
Returns the module configurations in a specified file.static Configuration
ConfigurationLoader. loadConfiguration(java.lang.String config, PropertyResolver overridePropsResolver, ThreadModeSettings threadModeSettings)
Returns the module configurations in a specified file.static Configuration
ConfigurationLoader. loadConfiguration(org.xml.sax.InputSource configSource, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions)
Returns the module configurations from a specified input source.static Configuration
ConfigurationLoader. loadConfiguration(org.xml.sax.InputSource configSource, PropertyResolver overridePropsResolver, ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions, ThreadModeSettings threadModeSettings)
Returns the module configurations from a specified input source.private static byte[]
PropertyCacheFile. loadExternalResource(java.lang.String location)
Loads the content of external resource.private static java.util.Properties
Main. loadProperties(java.io.File file)
Loads properties from a File.static void
JavadocPropertiesGenerator. main(java.lang.String... args)
TokenTypes.properties generator entry point.static DetailAST
JavaParser. parse(FileContents contents)
Static helper method to parses a Java source file.static DetailAST
JavaParser. parseFile(java.io.File file, JavaParser.Options options)
Parses Java source file.static DetailAST
JavaParser. parseFileText(FileText text, JavaParser.Options options)
Parse a text and return the parse tree.private static void
ConfigurationLoader. parsePropertyString(java.lang.String value, java.util.List<java.lang.String> fragments, java.util.List<java.lang.String> propertyRefs)
Parses a string containing${xxx}
style property references into two lists.static java.lang.String
AstTreeStringPrinter. printAst(FileText text, JavaParser.Options options)
Parse a file and print the parse tree.static java.lang.String
AstTreeStringPrinter. printFileAst(java.io.File file, JavaParser.Options options)
Parse a file and print the parse tree.static java.lang.String
AstTreeStringPrinter. printJavaAndJavadocTree(java.io.File file)
Prints full AST (java + comments + javadoc) of the java file.static java.lang.String
SuppressionsStringPrinter. printSuppressions(java.io.File file, java.lang.String suppressionLineColumnNumber, int tabWidth)
Prints generated suppressions.int
Checker. process(java.util.List<java.io.File> files)
private java.util.SortedSet<Violation>
Checker. processFile(java.io.File file)
Processes a file with all FileSetChecks.private static void
PackageNamesLoader. processFile(java.net.URL packageFile, PackageNamesLoader namesLoader)
Reads the file provided and parses it with package names loader.private void
Checker. processFiles(java.util.List<java.io.File> files)
Processes a list of files with all FileSetChecks.protected void
TreeWalker. processFiltered(java.io.File file, FileText fileText)
private void
TreeWalker. registerCheck(int tokenId, AbstractCheck check)
Register a check for a specified token id.private void
TreeWalker. registerCheck(AbstractCheck check)
Register a check for a given configuration.private static java.lang.String
ConfigurationLoader. replaceProperties(java.lang.String value, PropertyResolver props, java.lang.String defaultValue)
Replaces${xxx}
style constructions in the given value with the string value of the corresponding data types.private static int
Main. runCheckstyle(Main.CliOptions options, java.util.List<java.io.File> filesToProcess)
Executes required Checkstyle actions based on passed parameters.private static int
Main. runCli(Main.CliOptions options, java.util.List<java.io.File> filesToProcess)
Do execution of CheckStyle based on Command line options.protected void
Checker. setupChild(Configuration childConf)
Called by configure() for every child of this component's Configuration.void
TreeWalker. setupChild(Configuration childConf)
Called by configure() for every child of this component's Configuration.private static void
JavadocPropertiesGenerator. writePropertiesFile(JavadocPropertiesGenerator.CliOptions options)
Creates the .properties file from a .java file. -
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.api
Methods in com.puppycrawl.tools.checkstyle.api that throw CheckstyleException Modifier and Type Method Description void
AutomaticBean. configure(Configuration config)
Implements the Configurable interface using bean introspection.void
Configurable. configure(Configuration configuration)
Configures this component.void
AutomaticBean. contextualize(Context context)
Implements the Contextualizable interface using bean introspection.void
Contextualizable. contextualize(Context context)
Sets the context for this Component.protected void
AbstractViolationReporter. finishLocalSetup()
protected abstract void
AutomaticBean. finishLocalSetup()
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.java.lang.String
Configuration. getAttribute(java.lang.String name)
Deprecated.This shall be removed in future releases.java.lang.String
Configuration. getProperty(java.lang.String name)
The property value for n property name.java.util.SortedSet<Violation>
AbstractFileSetCheck. process(java.io.File file, FileText fileText)
java.util.SortedSet<Violation>
FileSetCheck. process(java.io.File file, FileText fileText)
Request to process a file.int
RootModule. process(java.util.List<java.io.File> files)
Processes a set of files.protected abstract void
AbstractFileSetCheck. processFiltered(java.io.File file, FileText fileText)
Called to process a file that matches the specified file extensions.protected void
AutomaticBean. setupChild(Configuration childConf)
Called by configure() for every child of this component's Configuration.private void
AutomaticBean. tryCopyProperty(java.lang.String key, java.lang.Object value, boolean recheck)
Recheck property and try to copy it. -
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.checks.header
Methods in com.puppycrawl.tools.checkstyle.checks.header that throw CheckstyleException Modifier and Type Method Description protected void
AbstractHeaderCheck. finishLocalSetup()
private void
AbstractHeaderCheck. loadHeaderFile()
Load the header from a file.void
AbstractHeaderCheck. setHeaderFile(java.net.URI uri)
Setter to specify the name of the file containing the required header.. -
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.checks.imports
Methods in com.puppycrawl.tools.checkstyle.checks.imports that throw CheckstyleException Modifier and Type Method Description static PkgImportControl
ImportControlLoader. load(java.net.URI uri)
Loads the import control file from a file.private static PkgImportControl
ImportControlLoader. load(org.xml.sax.InputSource source, java.net.URI uri)
Loads the import control file from aInputSource
.private static PkgImportControl
ImportControlLoader. loadUri(java.net.URI uri)
Loads the import control file from a URI. -
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.checks.javadoc
Methods in com.puppycrawl.tools.checkstyle.checks.javadoc that throw CheckstyleException Modifier and Type Method Description protected void
JavadocPackageCheck. processFiltered(java.io.File file, FileText fileText)
-
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.checks.regexp
Methods in com.puppycrawl.tools.checkstyle.checks.regexp that throw CheckstyleException Modifier and Type Method Description private static java.lang.String
RegexpOnFilenameCheck. getFolderPath(java.io.File file)
Retrieves the folder path from the givenfile
.protected void
RegexpOnFilenameCheck. processFiltered(java.io.File file, FileText fileText)
-
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.filters
Methods in com.puppycrawl.tools.checkstyle.filters that throw CheckstyleException Modifier and Type Method Description protected void
SuppressionFilter. finishLocalSetup()
protected void
SuppressionXpathFilter. finishLocalSetup()
private static SuppressionsLoader
SuppressionsLoader. getSuppressionLoader(org.xml.sax.InputSource source, java.lang.String sourceName)
Parses specified source and returns the suppression loader.static FilterSet
SuppressionsLoader. loadSuppressions(java.lang.String filename)
Returns the suppression filters in a specified file.private static FilterSet
SuppressionsLoader. loadSuppressions(org.xml.sax.InputSource source, java.lang.String sourceName)
Returns the suppression filters in a specified source.static java.util.Set<TreeWalkerFilter>
SuppressionsLoader. loadXpathSuppressions(java.lang.String filename)
Returns the suppressionTreeWalker
filters in a specified file.private static java.util.Set<TreeWalkerFilter>
SuppressionsLoader. loadXpathSuppressions(org.xml.sax.InputSource source, java.lang.String sourceName)
Returns the suppressionTreeWalker
filters in a specified source. -
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.gui
Methods in com.puppycrawl.tools.checkstyle.gui that throw CheckstyleException Modifier and Type Method Description void
MainFrameModel. openFile(java.io.File file)
Open file and load the file. -
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.meta
Methods in com.puppycrawl.tools.checkstyle.meta that throw CheckstyleException Modifier and Type Method Description private static void
MetadataGeneratorUtil. dumpMetadata(Checker checker, java.lang.String path, java.lang.String... moduleFolders)
Process files using the checker passed and write to corresponding XML files.static void
MetadataGeneratorUtil. generate(java.lang.String path, java.lang.String... moduleFolders)
Generate metadata from the module source files available in the input argument path. -
Uses of CheckstyleException in com.puppycrawl.tools.checkstyle.utils
Methods in com.puppycrawl.tools.checkstyle.utils that throw CheckstyleException Modifier and Type Method Description private static java.net.URI
CommonUtil. getFilepathOrClasspathUri(java.lang.String filename)
Resolves the specified local filename, possibly with 'classpath:' protocol, to a URI.static java.util.Properties
ChainedPropertyUtil. getResolvedProperties(java.util.Properties properties)
Accepts user defined properties and returns new properties with all chained properties resolved.static java.net.URI
CommonUtil. getResourceFromClassPath(java.lang.String filename)
Gets a resource from the classpath.static java.net.URI
CommonUtil. getUriByFilename(java.lang.String filename)
Resolve the specified filename to a URI.static java.lang.String
XpathUtil. printXpathBranch(java.lang.String xpath, java.io.File file)
Returns xpath query results on file as string.
-