Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep* (109)javax.ide.model.spi.* (13)javax.ide.model.text.* (2)javax.ide.model.xml.* (2)

javax.ide.model: Javadoc index of package javax.ide.model.

Package Samples:



TreeManager: The TreeManager serves as a FileT factory. Clients obtain FileTs by requesting a FileT from the manager and by creating empty FileTs through the manager. Clients change the writability of FileTs by opening and closing TreeTransactions. For the sake of transaction consistency, a FileT belongs to exactly one TreeManager for the lifetime of the FileT. The TreeManager owns a single lockable resource (which may be itself) which must, at the minumum, provide the functionality of a read-write lock. Each FileT is tied to a single lockable resource (which may be itself) which is defined by the owning IDE ...
DocumentFactory: The DocumentFactory interface is responsible for creating intances of Document s. The type of Document that gets created depends on the that is passed into the findOrCreate(URI) 55 and findOrCreate(MetaClass, URI) 55 methods. The DocumentFactory makes use of registered Recognizer instances to determine what Document class corresponds to a particular . JSR-198 specifies a number of ways to recognize documents: 1. By recognizing characteristics of the URI , 2. For XML documents by recognizing certain markups, and 3. By allowing extension writers to have full control of how ...
AnnotationT: An annotation (not to be confused with annotation type). Any declaration may be annotated, in particular, that means any T that extends HasModifiersT. For more information, please refer to the JLS 3rd ed, section 9.7. The first annotation variant is called a "normal" annotation. Consider: // Normal annotation RequestForEnhancement( id = 2868724, synopsis = "Provide time-travel functionality", engineer = "Mr. Peabody", date = "4/1/2004" ) public static void travelThroughTime(Date destination) { ... } getArguments() will return a list of four elements, each one will be an AssignmentExpressionT. The ...
Document: The Document interface is implemented by objects that can be saved and restored. These objects are generally persisted on some file system and are address using an unique . Documents are generally created using the DocumentFactory . This ensures that there is always one instance of a document pointed to by the same . The specification defines following types of documents: Project s: containing user work, javax.ide.model.text.TextDocument s: encapsulating text based files, s: encapsulating java files, and javax.ide.model.xml.XMLDocument s: ...
TypeD: Mirrors a type. Members A member should be listed in its respective member collection if it is either declared or inherited. Members that are not inherited should not be listed. Private members are never inherited. Package-private members are not inherited outside of the declaring package. Public members are always inherited. Note that constructors are never inherited. The order of the member listing should be determined by the type hierarchy. If type B occurs before type A in the type hierarchy, then all of B's declared members should occur before any of A's declared members in the member collection. ...
TreeResolver: The TreeResolver provides a facility for resolving type and declaration references on Trees. Methods are provided for resolving individual Tree objects. Other methods are provided for resolving an entire FileT. The TreeResolver may need to acquire resource(s) as it performs resolution. Callers should be warned that TreeResolver operations may therefore block unless the underlying resource has already been acquired. TODO: How does a caller acquire said resources? In particular, this is a problem since the resolution does not know ahead of time which compilation units will need to be read to perform ...
TreeKind: The TreeKind enumeration identifies each individual kind of Tree. For code-readability, all constants have been prefixed as TREE_*. Constants for subinterfaces of StatementT have been prefixed as TREE_STMT_*. Constants for subinterfaces of ExpressionT have been prefixed as TREE_EXPR_*. Constants for subinterfaces of DocT have been prefixed as TREE_DOC_*. Though the doc structure is not part of the Java Language specification (moreover, there is no specification of doc structure), doc comment constants have been included because refactoring features may need to access and mutate doc comment contents. ...
JavaModel: The JavaModel is the central point of access to all source compilation unit facilities. Read and write access to parse trees is provided through the TreeManager interface. The ability to resolve source references to declarations is provided through the TreeResolver interface. The ability to fetch the source for a declaration is provided through the TreeLocator interface. Finally, declaration loading is provided through the JavaModel interface itself. Typically, a JavaModel will have an underlying classpath and sourcepath that define its search path.
DocTagT: A tag within a doc comment. Unlike com.sun.javadoc.Tag, a DocTagT does not represent text. A DocTagT only represents words prefixed with a leading that follow the javadoc rules, i.e. a block tag starts on its own line and an inline tag is prefixed with '. The doc tag name are composed of a leading followed by a qualified name where, unlike in Java, '-' in considered to be part of a tag identifier. "Standard tag" means a tag defined by the standard doclet.
AssertStatementT: An assert statement. JLS3 14.10. An assert statement has a conditional expression and an optional detail message expression. Here are some examples: assert enabled == true; assert(enabled == true); assert enabled == true: "Not enabled"; If there is a second expression and the condition evaluates to false, then the second expression is evaluated and then converted to a String used to create a new AssertionError.
ElementDisplayInfo: Display information about a JSR-198 element. This class allows custom Elements (extension-provided subclasses of Element, Document, TextDocument or XMLDocument) to configure the way they appear in the IDE. Any methods on this class may return null. If they do, IDEs will display the element in whatever the "default" way is for nodes of this type. This implementation returns null from all methods.
Recognizer: The Recognizer interface provides the API for recognizing data types from specific uris. Data model frameworks can register their own recognizer with the DocumentFactory .
LiteralExpressionT: An expression representing a lexer literal. Class literals and this literals, though called "literal", are not here considered to be literal expressions. As a result of this definition, the value of all LiteralExpressionTs can be determined at parse-time whereas the value of class literals and this literals can only be determined at compile-time.
DocElementT: Common supertype for all elements that are a part of a doc comment. Not named DocT in order to avoid confusion with com.sun.javadoc.Doc which is not the base supertype of all doc elements. "Comment text" refers to text with leading asterisks stripped. "Processed text" refers to text with tags stripped.
Folder: The Folder interface extends Element by adding methods for managing child Element s contained by the Folder .
StatementT: Common supertype of all statements. All statements can be classified as: simple, block, compound. Block statements are statements that are blocks. Simple statements have no child statements and optionally have expressions. Compound statements have child statements and optionally have expressions.
Element: The Element interface defines the protocol used by the IDE to communicate with data objects in order to display the objects in the UI. For example, objects that need to be shown in an the project explorer window will need to implement the Element interface.
DocCommentT: A doc comment (short for "documentation comment"). Corresponds to com.sun.javadoc.Doc in the Doclet API. Named DocCommentT to avoid confusion with the other convention of ExpressionT and StatementT that indicate common supertypes because the DocCommentT is not a common supertype.
InfixExpressionT: An expression involving an infix operation (but not an assignment operation). Infix expressions usually have two operands. Commutative and associative operators may have more than two. The infix operators are: + - * / % && || & | ^ instanceof
WrapperExpressionT: An expression wrapping another one, either with parentheses or brackets. Notice the difference between a WrapperExpression and a ListExpression. Wrapper expressions always have a single operand whereas list expressions may have a variable number of operands.
TypecastExpressionT: An expression performing a typecast operation. Though technically, a typecast is a prefix operation, it is here represented separately because it has two operands (a type lhs and an expression rhs) and it is not commonly thought of as a typical prefix operator.
ExpressionT: Common supertypes for all expressions. If it is a primary, selector, or method invocation, it has a name. Otherwise, it is an operator of some sort and has operands. With each enumerated constant is a description of which fields are non-null and useful.
Project: Project interface. Projects are documents encapsulating the user work. A project specifies the source path where the java source files are rooted, the class path used when compiling and running the project, the ouput path where compiled classes are saved.
BlockT: A code block. Blocks may be children of methods declarations, constructor declarations, class initializers, and statements. A block may contain any child that extends BlockElementT, in particular: ClassT, LocalVariableDeclT, StatementT, SwitchLabelT.
DocumentListener: The DocumentListener interface should be implemented by clients that are interested in being notified about operations on Document s.

Home | Contact Us | Privacy Policy | Terms of Service