Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ usage Javadoc ]

•	com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.* (56)

• com.puppycrawl.tools.checkstyle.checks.usage: Javadoc index of package com.puppycrawl.tools.checkstyle.checks.usage.


Package Samples:

• com.puppycrawl.tools.checkstyle.checks.usage.transmogrify: Contains the Usage checks that are bundled with the main distribution.  

Classes:

• TableMaker: this is the class that does the work of the "walking" step -- going through the SymTabAST and constructing the definitions and references. The SymTabAST is constructed in a DOMish fashion, i.e. each node knows about its first child and its next sibling. The DFS search is carried out by two functions -- walkTree, which deals with a single SymTabAST node, and walkSibilngs, which deals with all the siblings of an SymTabAST node.
• SymbolTable: this class contains all of the definitions, references, and scopes created by the system. Other stuff this class does: holds the "base" scope containing primitive definitions holds the java.lang package holds the definition of java.lang.Object, which is the base class of all class hierarchies kicks off the resolve step does some of the work of constructing object definitions
• SymTabAST: an extension of antlr.CommonAST that includes extra information about the AST's location. This information is the file and line number where the AST was created. To use this AST node in your tree structure, assuming your antlr.TreeParser is called parser, use parser.setASTNOdeCLass(SymTabAST.class.getName()); make sure you also call setTokenObjectClass for the lexer as well
• OneMethodPrivateFieldCheck: Checks that a private field is used in more than one method, constructor, or initializer. Rationale: a private field used in only one method, constructor, or initializer should be replaced by a local variable. An example of how to configure the check is: <module name="usage.OneMethodPrivateField"/>
• Reference: represents a place where a definition is used. There are two flavors of references -- resolved (those that have a definition associated with them) and unresolved (those that don't have a definition associated). The goal of the resolution step is to get all of the references in the symbol table to fall into the resolved category.
• ClassDef: ClassDef contains all the information needed to represent a java class or interface. This includes the superclass, whether it's a class or an interface, the interfaces it implements, a list of its (direct?) subclasses, and the classes that implement it if it is an interface
• BlockDef: BlockDef is a Scope which contains information about everything that defines a nameless block of java code. There are provisions for keeping the name of several anonymous blocks of java code within the same parent scope to have unique names.
• Definition: Definition contains basic information for everything that is defined in a java source file. A definition has a list of Reference s, an Occurrence , a name, and a parent Scope .
• IClass: interface implemented by classes/interfaces definition, for source or non-sourced classes and interfaces The implementor of this class have all information about its inner classes, methods, variables, subclasses, etc.
• UnusedLocalVariableCheck: Checks that a local variable is read. An example of how to configure the check is: <module name="usage.UnusedLocalVariable"/>
• UnusedPrivateMethodCheck: Checks that a private method is used. An example of how to configure the check is: <module name="usage.UnusedPrivateMethod"/>
• UnusedPrivateFieldCheck: Checks that a private field is used. An example of how to configure the check is: <module name="usage.UnusedPrivateField"/>
• Occurrence: Occurrence contains file and line number information. It is used to denote the location of various Definintion s and Reference s
• UnusedParameterCheck: Checks that a parameter is used. An example of how to configure the check is: <module name="usage.UnusedParameter"/>
• ExternalMethod: MethodDef contains all the pertinent information for a method, including return type, formal parameters, and exceptions thrown
• IMethod: MethodDef contains all the pertinent information for a method, including return type, formal parameters, and exceptions thrown
• MethodDef: MethodDef contains all the pertinent information for a method, including return type, formal parameters, and exceptions thrown
• LiteralResolver: Resolves primitive identifiers (int, double) to their corresponding ClassDef . This class uses the Singleton pattern.
• MethodSignature: MethodSignature is used to resolve various methods in the same scope of the same name based on formal parameter lists
• Resolver: The resolver is responsible for traversing all the various definitions in a symbol table and resolving references in them.
• ExternalVariable: VariableDef is a Definition that contains information about the definition of a variable.
• ScopeIndex: ScopeIndex provides methods for finding Scope s related to a known Occurrence
• VariableDef: VariableDef is a Definition that contains information about the definition of a variable.
• ASTManager: Manages AST trees and nodes. Capable of managing multiple parse trees, which is useful for inter-file checks.
• LabelDef: LabelDef is a Definition that contains information about the definition of a Label.

Home | Contact Us | Privacy Policy | Terms of Service