jdt

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » IDE Eclipse » jdt 
Eclipse jdt
License:Eclipse Public License Version
URL:http://www.eclipse.com
Description:
Package NameComment
com.sun.jdi Eclipse JDI Interfaces

Provides JDI interfaces

Package Specification

This package provides a definition of the JDI class interfaces as specified in the JPDA. The specification for these interfaces can be found at http://java.sun.com/j2se/1.5.0/docs/guide/jpda/jdi/index.html

com.sun.jdi.connect Eclipse JDI Interfaces

Provides JDI interfaces

Package Specification

This package provides a definition of the JDI class interfaces as specified in the JPDA. The specification for these interfaces can be found at http://java.sun.com/j2se/1.5.0/docs/guide/jpda/jdi/index.html

com.sun.jdi.connect.spi Eclipse JDI Interfaces

Provides JDI interfaces

Package Specification

This package provides a definition of the JDI class interfaces as specified in the JPDA. The specification for these interfaces can be found at http://java.sun.com/j2se/1.5.0/docs/guide/jpda/jdi/index.html

com.sun.jdi.event Eclipse JDI Interfaces

Provides JDI interfaces

Package Specification

This package provides a definition of the JDI class interfaces as specified in the JPDA. The specification for these interfaces can be found at http://java.sun.com/j2se/1.5.0/docs/guide/jpda/jdi/index.html

com.sun.jdi.request Eclipse JDI Interfaces

Provides JDI interfaces

Package Specification

This package provides a definition of the JDI class interfaces as specified in the JPDA. The specification for these interfaces can be found at http://java.sun.com/j2se/1.5.0/docs/guide/jpda/jdi/index.html

com.sun.mirror.apt Classes used to communicate information between {@linkplain com.sun.mirror.apt.AnnotationProcessor annotation processors} and an annotation processing tool.

Note that the apt tool and its associated APIs may be changed or superseded in future j2se releases. @since 1.5

com.sun.mirror.declaration Interfaces used to model program element declarations. A declaration is represented by the appropriate subinterface of {@link com.sun.mirror.declaration.Declaration}, and an annotation is represented as an {@link com.sun.mirror.declaration.AnnotationMirror}.

Note that the apt tool and its associated APIs may be changed or superseded in future j2se releases. @since 1.5

com.sun.mirror.type Interfaces used to model types. A type is represented by the appropriate subinterface of {@link com.sun.mirror.type.TypeMirror}.

Note that the apt tool and its associated APIs may be changed or superseded in future j2se releases. @since 1.5

com.sun.mirror.util Utilities to assist in the processing of {@linkplain com.sun.mirror.declaration declarations} and {@linkplain com.sun.mirror.type types}.

Note that the apt tool and its associated APIs may be changed or superseded in future j2se releases. @since 1.5

org.eclipse.core.indexsearch
org.eclipse.debug.jdi.tests
org.eclipse.debug.jdi.tests.program
org.eclipse.jdi
org.eclipse.jdi.hcr
org.eclipse.jdi.internal
org.eclipse.jdi.internal.connect
org.eclipse.jdi.internal.event
org.eclipse.jdi.internal.jdwp
org.eclipse.jdi.internal.request
org.eclipse.jdi.internal.spy
org.eclipse.jdt.apt.core.build Package-level Javadoc This package contains utilities for annotation processing in command-line builds and ant scripts.

Package Specification


This package contains utilities for performing Java annotation processing in command-line builds and ant scripts.

org.eclipse.jdt.apt.core.env Package-level Javadoc This package contains Eclipse extensions to some of the Sun annotation processing APIs.

Package Specification


This package contains Eclipse extensions of APIs related to the com.sun.mirror.apt.AnnotationProcessorEnvironment interface. Use these extensions in order to access features available only within Eclipse. Avoid these extensions if compatibility with Sun's apt tool is required.

org.eclipse.jdt.apt.core.internal
org.eclipse.jdt.apt.core.internal.build
org.eclipse.jdt.apt.core.internal.declaration
org.eclipse.jdt.apt.core.internal.env
org.eclipse.jdt.apt.core.internal.generatedfile
org.eclipse.jdt.apt.core.internal.type
org.eclipse.jdt.apt.core.internal.util
org.eclipse.jdt.apt.core.util Package-level Javadoc This package contains miscellaneous APIs related to Java annotation processing.

Package Specification


This package contains miscellaneous utilities related to Java annotation processing, such as the APIs needed to configure the annotation processor settings and factory path.

org.eclipse.jdt.apt.pluggable.tests
org.eclipse.jdt.apt.pluggable.tests.annotations
org.eclipse.jdt.apt.pluggable.tests.processors.genclass6
org.eclipse.jdt.apt.pluggable.tests.processors.message6
org.eclipse.jdt.apt.tests
org.eclipse.jdt.apt.tests.annotations
org.eclipse.jdt.apt.tests.annotations.apitest
org.eclipse.jdt.apt.tests.annotations.aptrounding
org.eclipse.jdt.apt.tests.annotations.exceptionhandling
org.eclipse.jdt.apt.tests.annotations.extradependency
org.eclipse.jdt.apt.tests.annotations.filegen
org.eclipse.jdt.apt.tests.annotations.generic
org.eclipse.jdt.apt.tests.annotations.helloworld
org.eclipse.jdt.apt.tests.annotations.listener
org.eclipse.jdt.apt.tests.annotations.messager
org.eclipse.jdt.apt.tests.annotations.mirrortest
org.eclipse.jdt.apt.tests.annotations.nestedhelloworld
org.eclipse.jdt.apt.tests.annotations.noop
org.eclipse.jdt.apt.tests.annotations.pause
org.eclipse.jdt.apt.tests.annotations.readannotation
org.eclipse.jdt.apt.tests.annotations.readAnnotationType
org.eclipse.jdt.apt.tests.annotations.valueconversion
org.eclipse.jdt.apt.tests.external.annotations.batch
org.eclipse.jdt.apt.tests.external.annotations.classloader
org.eclipse.jdt.apt.tests.external.annotations.loadertest
org.eclipse.jdt.apt.tests.jdtcoretests
org.eclipse.jdt.apt.tests.plugin
org.eclipse.jdt.apt.ui.internal
org.eclipse.jdt.apt.ui.internal.preferences
org.eclipse.jdt.apt.ui.internal.util
org.eclipse.jdt.compiler.apt.tests
org.eclipse.jdt.core Package-level Javadoc The Java model is the set of classes that model the objects associated with creating, editing, and building a Java program.

Package Specification


This package contains the Java model classes, which implement Java specific behaviour for resources and further decompose java resources into model elements.

org.eclipse.jdt.core.compiler Package-level Javadoc This package contains compiler associated infrastructure APIs.

Package Specification


This package contains some compiler tooling APIs, allowing to perform operations at a lower-level than using the JavaModel.

org.eclipse.jdt.core.dom Package-level Javadoc The Java DOM/AST is the set of classes that model the source code of a Java program as a structured document.

Package Specification


This package contains the Java DOM/AST classes. An API for manipulating the source code of a Java program as a structured document. In particular, it provides a full abstract syntax tree for a Java compilation unit, which can be queried for resolved type information, and modified. The principal classes are {@link org.eclipse.jdt.core.dom.AST AST} {@link org.eclipse.jdt.core.dom.ASTNode ASTNode}, and {@link org.eclipse.jdt.core.dom.ASTParser ASTParser}.

org.eclipse.jdt.core.dom.rewrite Package-level Javadoc The Java DOM/AST rewrite is the set of classes that are used to make changes to an existing DOM/AST tree.

Package Specification

This package contains the Java DOM/AST classes used to make changes to an existing DOM/AST tree. The principal classes are {@link org.eclipse.jdt.core.dom.rewrite.ASTRewrite ASTRewrite} and {@link org.eclipse.jdt.core.dom.rewrite.ListRewrite ListRewrite}.

org.eclipse.jdt.core.eval Package-level Javadoc Provides support for the evaluation of code snippets in a scrapbook or inside the debugger.

Package Specification

This packages provides support for the evaluation of code snippets in a scrapbook or inside the debugger.
org.eclipse.jdt.core.formatter Package-level Javadoc The code formatter is the set of classes that are used to format Java code.

Package Specification

This package contains classes to format Java code. The principal classes are {@link org.eclipse.jdt.core.formatter.CodeFormatter CodeFormatter} and {@link org.eclipse.jdt.core.formatter.DefaultCodeFormatterConstants DefaultCodeFormatterConstants}.

org.eclipse.jdt.core.jdom Package-level Javadoc Provides a support for Java document manipulation through the JDOM model.

Package Specification

This package provides a support for Java document manipulation through the JDOM model.

The JDOM was made obsolete by the addition in 2.0 of the more powerful, fine-grained DOM/AST API found in the org.eclipse.jdt.core.dom package.

org.eclipse.jdt.core.search Package-level Javadoc Provides support for searching the workspace Java elements that match a particular description.

Package Specification

This package provides support for searching the workspace Java elements that match a particular description. In particular, it provides a search engine with a set of search patterns and search result requestors.
org.eclipse.jdt.core.util Package-level Javadoc Provides a set of tools and utilities for manipulating .class files and Java model elements.

Package Specification

This package provides a set of tools and utilities for manipulating .class files and Java model elements.
org.eclipse.jdt.debug.core Java Debug Model

Provides an implementation of a debug model based on JPDA (Java Platform Debug Architecture).

Package Specification

This package provides a set of classes and interfaces that implement a debug model based on JPDA/JDI (Java Debug Interface). It provides a set of interfaces that extend the base set of debug element interfaces to provide access to Java specific attributes and behavior. This model defines and provides utilities for creating line breakpoints, method entry breakpoints, exception breakpoints, and field watchpoints.

org.eclipse.jdt.debug.eval Java Debug Model

Provides a set classes and interfaces that support evaluations in the Java debugger.

Package Specification

This package defines a set of classes and interfaces that support evaluations in the Java debugger. Two evaluation engines are provided - one that performs evaluations by compiling and deploying class files locally for execution, and one that performs an interpretation over an abstract syntax tree. The later supports remote evaluation via JDI.

org.eclipse.jdt.internal.antadapter
org.eclipse.jdt.internal.apt.pluggable.core
org.eclipse.jdt.internal.apt.pluggable.core.dispatch
org.eclipse.jdt.internal.apt.pluggable.core.filer
org.eclipse.jdt.internal.codeassist
org.eclipse.jdt.internal.codeassist.complete
org.eclipse.jdt.internal.codeassist.impl
org.eclipse.jdt.internal.codeassist.select
org.eclipse.jdt.internal.compiler
org.eclipse.jdt.internal.compiler.apt.dispatch
org.eclipse.jdt.internal.compiler.apt.model
org.eclipse.jdt.internal.compiler.apt.util
org.eclipse.jdt.internal.compiler.ast
org.eclipse.jdt.internal.compiler.batch
org.eclipse.jdt.internal.compiler.classfmt
org.eclipse.jdt.internal.compiler.codegen
org.eclipse.jdt.internal.compiler.env
org.eclipse.jdt.internal.compiler.flow
org.eclipse.jdt.internal.compiler.impl
org.eclipse.jdt.internal.compiler.lookup
org.eclipse.jdt.internal.compiler.parser
org.eclipse.jdt.internal.compiler.parser.diagnose
org.eclipse.jdt.internal.compiler.problem
org.eclipse.jdt.internal.compiler.tool
org.eclipse.jdt.internal.compiler.util
org.eclipse.jdt.internal.core
org.eclipse.jdt.internal.core.builder
org.eclipse.jdt.internal.core.dom.rewrite
org.eclipse.jdt.internal.core.eval
org.eclipse.jdt.internal.core.hierarchy
org.eclipse.jdt.internal.core.index
org.eclipse.jdt.internal.core.jdom
org.eclipse.jdt.internal.core.search
org.eclipse.jdt.internal.core.search.indexing
org.eclipse.jdt.internal.core.search.matching
org.eclipse.jdt.internal.core.search.processing
org.eclipse.jdt.internal.core.util
org.eclipse.jdt.internal.corext
org.eclipse.jdt.internal.corext.buildpath
org.eclipse.jdt.internal.corext.callhierarchy
org.eclipse.jdt.internal.corext.codemanipulation
org.eclipse.jdt.internal.corext.dom
org.eclipse.jdt.internal.corext.dom.fragments
org.eclipse.jdt.internal.corext.fix
org.eclipse.jdt.internal.corext.javadoc
org.eclipse.jdt.internal.corext.refactoring
org.eclipse.jdt.internal.corext.refactoring.base
org.eclipse.jdt.internal.corext.refactoring.binary
org.eclipse.jdt.internal.corext.refactoring.changes
org.eclipse.jdt.internal.corext.refactoring.code
org.eclipse.jdt.internal.corext.refactoring.code.flow
org.eclipse.jdt.internal.corext.refactoring.delegates
org.eclipse.jdt.internal.corext.refactoring.generics
org.eclipse.jdt.internal.corext.refactoring.nls
org.eclipse.jdt.internal.corext.refactoring.nls.changes
org.eclipse.jdt.internal.corext.refactoring.participants
org.eclipse.jdt.internal.corext.refactoring.rename
org.eclipse.jdt.internal.corext.refactoring.reorg
org.eclipse.jdt.internal.corext.refactoring.scripting
org.eclipse.jdt.internal.corext.refactoring.sef
org.eclipse.jdt.internal.corext.refactoring.structure
org.eclipse.jdt.internal.corext.refactoring.structure.constraints
org.eclipse.jdt.internal.corext.refactoring.surround
org.eclipse.jdt.internal.corext.refactoring.tagging
org.eclipse.jdt.internal.corext.refactoring.typeconstraints
org.eclipse.jdt.internal.corext.refactoring.typeconstraints.types
org.eclipse.jdt.internal.corext.refactoring.typeconstraints.typesets
org.eclipse.jdt.internal.corext.refactoring.typeconstraints2
org.eclipse.jdt.internal.corext.refactoring.util
org.eclipse.jdt.internal.corext.template.java
org.eclipse.jdt.internal.corext.util
org.eclipse.jdt.internal.debug.core
org.eclipse.jdt.internal.debug.core.breakpoints
org.eclipse.jdt.internal.debug.core.hcr
org.eclipse.jdt.internal.debug.core.logicalstructures
org.eclipse.jdt.internal.debug.core.model
org.eclipse.jdt.internal.debug.eval
org.eclipse.jdt.internal.debug.eval.ast.engine
org.eclipse.jdt.internal.debug.eval.ast.instructions
org.eclipse.jdt.internal.eval
org.eclipse.jdt.internal.formatter
org.eclipse.jdt.internal.formatter.align
org.eclipse.jdt.internal.formatter.comment Package-level Javadoc Provides facilities to format comments in Java source code.

Package Specification

This package provides interfaces and implementations for three kinds of comment types used in Java source code:
  • Javadoc comments
  • Multi-line comments
  • Single-line comments

Comment Formatting

Comment regions form the principle access point to the formatting of comments. To create a comment region for a specified comment type, the factory method CommentObjectFactory#createRegion(IDocument, TypedPosition, String, Map, StyledText) should be used.

The formatting process is then launch by calling CommentRegion#format(String), where the argument denotes the desired indentation. This method returns a textedit representing the changes that where made during the formatting process. The document for which the comment region was created is therefore guaranteed to remain unchanged.

Internally, the comment region is first cast into comment lines to form the basis of the following scan step: Each comment line is scanned for valid prefixes and tokenized afterwards. This tokenize step yields a stream of tokens called comment ranges that are then marked with attributes representing information about the kind of token associated with that comment range.

Once the comment ranges have enough attributed information, the comment region wraps the comment ranges at the line margin boundary. This is coordinated by a set of rules that can be contributed to a certain type of comment region. At this point of time, the comment range stream already represents the formatted comment region. The last step therefore is to record the edits and to construct the resulting text edit, which describes all the changes that were made to the comment region.
Note that the changes are not directly applied to the document. Clients are responsible for applying the textedit and updating and preserving the document structure.

All the objects used during comment formatting should not directly be instantiated, but rather retrieved from the factory CommentObjectFactory. This factory ensures that the right kind of regions and lines are returned for a specific comment type.

org.eclipse.jdt.internal.formatter.old
org.eclipse.jdt.internal.launching
org.eclipse.jdt.internal.launching.environments
org.eclipse.jdt.internal.launching.j9
org.eclipse.jdt.internal.launching.macosx
org.eclipse.jdt.internal.launching.support
org.eclipse.jdt.internal.ui
org.eclipse.jdt.internal.ui.actions
org.eclipse.jdt.internal.ui.browsing
org.eclipse.jdt.internal.ui.callhierarchy
org.eclipse.jdt.internal.ui.commands
org.eclipse.jdt.internal.ui.compare
org.eclipse.jdt.internal.ui.dialogs
org.eclipse.jdt.internal.ui.dnd
org.eclipse.jdt.internal.ui.exampleprojects
org.eclipse.jdt.internal.ui.examples.jspeditor
org.eclipse.jdt.internal.ui.filters
org.eclipse.jdt.internal.ui.fix
org.eclipse.jdt.internal.ui.infoviews
org.eclipse.jdt.internal.ui.jarimport
org.eclipse.jdt.internal.ui.jarpackager
org.eclipse.jdt.internal.ui.javadocexport
org.eclipse.jdt.internal.ui.javaeditor
org.eclipse.jdt.internal.ui.javaeditor.saveparticipant
org.eclipse.jdt.internal.ui.javaeditor.selectionactions
org.eclipse.jdt.internal.ui.macbundler
org.eclipse.jdt.internal.ui.model
org.eclipse.jdt.internal.ui.navigator
org.eclipse.jdt.internal.ui.packageview
org.eclipse.jdt.internal.ui.preferences
org.eclipse.jdt.internal.ui.preferences.cleanup
org.eclipse.jdt.internal.ui.preferences.formatter
org.eclipse.jdt.internal.ui.propertiesfileeditor
org.eclipse.jdt.internal.ui.refactoring
org.eclipse.jdt.internal.ui.refactoring.actions
org.eclipse.jdt.internal.ui.refactoring.binary
org.eclipse.jdt.internal.ui.refactoring.code
org.eclipse.jdt.internal.ui.refactoring.contentassist
org.eclipse.jdt.internal.ui.refactoring.nls
org.eclipse.jdt.internal.ui.refactoring.nls.search
org.eclipse.jdt.internal.ui.refactoring.reorg
org.eclipse.jdt.internal.ui.refactoring.sef
org.eclipse.jdt.internal.ui.search
org.eclipse.jdt.internal.ui.text
org.eclipse.jdt.internal.ui.text.comment
org.eclipse.jdt.internal.ui.text.correction
org.eclipse.jdt.internal.ui.text.correction.proposals
org.eclipse.jdt.internal.ui.text.folding
org.eclipse.jdt.internal.ui.text.java
org.eclipse.jdt.internal.ui.text.java.hover
org.eclipse.jdt.internal.ui.text.javadoc
org.eclipse.jdt.internal.ui.text.spelling Package-level Javadoc Provides facilities for spell-checking of comments and strings in Java source code.

Package Specification

The content of this package extends the base functionality of the spell-checking engine.

It contains a spell-check engine specialized in Javadoc comments. Several dictionaries with Java specific content like Javadoc keywords, HTML tags and Task tags are provided. Additionally, the engine contributes correction proposals to the QuickFix processor. For non Java specific content the engine also contributes word completion proposals to the content assist processor.

Spell-check engine

SpellCheckEngine is the default implementation of the interface ISpellCheckEngine. It provides a facade for dealing with the setup of a spell-checker. This class provides methods to retrieve the available dictionaries and is responsible for the registration of those with the spell-checker. SpellCheckEngine also has support for life-cycle management. Single dictionaries can be temporarily unloaded from memory or unregistered.
To contribute own dictionaries use the methods to register locale sensitive or insensitive dictionaries. A dictionary can be associated to a specified locale, but can also be available for spell-checking arbitrary text in arbitrary languages. The actual spell-checker for a specified language can then be obtained by calling createSpellChecker(Locale). This is the central point to working with the spell-checker. When requesting a spell-checker for a specified locale, the engine looks up the corresponding dictionary and registers it with the spell-checker. Note that the dictionaries are lazily loaded and can be further optimized by prefiltering the queried words.

Note: Locale sensitive dictionaries must be located in the "dictionaries/" subdirectory of the JDT UI plugin install location. The dictionaries are newline-separated word lists having the filename "language_country.dictionary", where "language" and "country" are the lowercase ISO-3166 language and country codes, respectively. The default dictionary is "en_us.dictionary". For correct behavior of the spell-check engine, at least the default dictionary must be installed. The default dictionary corresponds to the default locale of the spell-check engine.

Dictionaries

This implementation for a Javadoc comment spell-checker provides the following read-only dictionaries:
  • A dictionary for Javadoc tags: This dictionary contains the most commonly used Javadoc tags. When spell-checking Javadoc comments, this dictionary contributes correction proposals to the QuickFix processor to correct misspelt Javadoc tags.
  • A dictionary for HTML tags: This dictionary contains the most commonly used HTML tags for writing Javadoc comments. When spell-checking Javadoc- or multiline comments, this dictionary contributes correction proposals to the QuickFix processor as well as word completion proposals to the Content Assist processor.
  • A dictionary for Task tags: This dictionary reflects the currently available Java Task tags. When spell-checking arbitrary text in Java files, this dictionary contributes proposals both to the QuickFix processor and the Content Assist processor.

QuickFix processor

The comment spell-checker also contributes a quickfix processor as an extension. This implementation of a quickfix processor contributes the following correction proposals:
  • Proposals for correct spelling: A number of words considered most similar to the incorrectly spelt word.
  • The proposal to correct the sentence capitalization: This proposal is offered on incorrectly spelt words at the beginning of a sentence.
  • The proposal to add the unrecognized word to the locale-insensitive dictionaries
  • The proposal to ignore the word during the current editing session

Content Assist processor

The last contribution of the spell-checker is the support for word completion. The spell-checker provides a custom content assist processor to produce word completion proposals.
Word completion works on all non Java code content types and delivers a number of proposals based on the current caret position.
org.eclipse.jdt.internal.ui.text.spelling.engine Package-level Javadoc Provides the core functionality for spell-checking documents

Package Specification

This package provides the interfaces for the notions of dictionary, edit distance, phonetic hash, spell event and spell-check iterator. For most of these interfaces a default implementation for english languages is provided. These implementations can be reused in custom dictionaries or spell-check iterators, or replaced by more specialized algorithms for a particular group of languages.

Spell Check Engine

The central point to access the spell-checker functionality is the interface ISpellCheckEngine. Implementations of this interface provide support for life-cycle management, registering and unregistering dictionaries, changing the locale of the engine and creating a spell-checker for a specific language.

The following steps are needed to obtain a spell-checker for a specific language:

  • Create an instance of ISpellCheckEngine. In this package, no default implementation is provided, since the management of the dictionary registering and loading is application dependent. Usually, instances of ISpellCheckEngine are implemented as singletons.
  • Create the appropriate dictionaries that should be used during the spell-check process. All dictionaries that can be registered with ISpellCheckEngine must implement the interface ISpellCheckDictionary. For this interface, an abstract implementation is provided in the class AbstractSpellDictionary. Depending on the language of the words contained in this dictionary, custom algorithms for the phonetic hash (IPhoneticHashProvider) and the edit distance (IPhoneticDistanceAlgorithm) should be implemented and registered with the dictionary.
  • Instances of spell-checkers can now be created by calling createSpellChecker(Locale), where the locale denotes the language that the spell-checker should use while executing.
When requesting a new spell-checker with a different locale via createSpellChecker(Locale), the spell-checker is reconfigured with the new dictionaries. More concretely, the old dictionary is unregistered and a new one registered for the desired locale is associated with the spell-checker. If no such dictionary is available, no spell-checker is returned and the locale of the engine is reset to its default locale.

Dictionaries

Dictionaries are the data structures to hold word lists for a particular language. All implementations of dictionaries must implement the interface ISpellDictionary. It provides support for life-cycle management as well as the facility to query words from the list, add words to the list and get correction proposals for incorrectly spelt words.

This package provides a default implementation of a dictionary (AbstractSpellDictionary) that uses algorithms convenient for english languages.
Every dictionary needs two kinds of algorithms to be plugged in:

  • An edit distance algorithm: Edit distance algorithms implement the interface IPhoneticDistanceAlgorithm. The algorithm is used to determine the similarity between two words. This package provides a default implementation for languages using the latin alphabet (DefaultPhoneticDistanceAlgorithm). The default algorithm uses the Levenshtein text edit distance.
  • A hash algorithm: Phonetic hash providers implement the interface IPhoneticHashProvider. The purpose of phonetic hashes is to have a representation of words which allows comparing it to other, similar words. This package provides a default implementation which is convenient for slavic and english languages. It uses the double metaphone algorithm by published Lawrence Philips.
By plugging in custom implementations of one or both of these algorithms the abstract implementation AbstractSpellDictionary can be customized to specified languages and alphabets.

Spell Check Iterators

Instances of ISpellChecker are usually language-, locale- and medium independent implementations and therefore need an input provider. The interface ISpellCheckIterator serves this purpose by abstracting the tokenizing of text media to a simple iteration. The actual spell-check process is launched by calling ISpellChecker#execute(ISpellCheckIterator). This method uses the indicated spell-check iterator to determine the words that are to be spell-checked. This package provides no default implementation of a spell-check iterator.

Event Handling

To communicate the results of a spell-check pass, spell-checkers fire spell events that inform listeners about the status of a particular word being spell-checked. Instances that are interested in receiving spell events must implement the interface ISpellEventListener and register with the spell-checker before the spell-check process starts.

A spell event contains the following information:

  • The word being spell-checked
  • The begin index of the current word in the text medium
  • The end index in the text medium
  • A flag whether this word was found in one of the registered dictionaries
  • A flag that indicates whether this word starts a new sentence
  • The set of proposals if the word was not correctly spelt. This information is lazily computed.
Spell event listeners are free to handle the events in any way. However, listeners are not allowed to block during the event handling unless the spell-checking process happens in another thread.
org.eclipse.jdt.internal.ui.text.template.contentassist
org.eclipse.jdt.internal.ui.text.template.preferences
org.eclipse.jdt.internal.ui.typehierarchy
org.eclipse.jdt.internal.ui.util
org.eclipse.jdt.internal.ui.viewsupport
org.eclipse.jdt.internal.ui.wizards
org.eclipse.jdt.internal.ui.wizards.buildpaths
org.eclipse.jdt.internal.ui.wizards.buildpaths.newsourcepage
org.eclipse.jdt.internal.ui.wizards.dialogfields
org.eclipse.jdt.internal.ui.workingsets
org.eclipse.jdt.junit.tests
org.eclipse.jdt.launching Package-level Javadoc Application programming interfaces for interaction with the Eclipse Java launching support.

Package Specification

Provides support for describing installed Java runtime environments and launching Java virtual machines.
org.eclipse.jdt.launching.environments Package-level Javadoc Application programming interfaces and classes for execution environments.

Package Specification

Provides support for execution environments.

An execution environment describes the capabilities of a Java runtime environment, for example J2SE-1.4. This package provides facilities for contributing execution environments and providing analyzers to identify JREs as compatible with execution environments.

org.eclipse.jdt.launching.j9
org.eclipse.jdt.launching.sourcelookup Package-level Javadoc Application programming interfaces and classes for source lookup.

Package Specification

Provides support for source lookup.

These classes and interfaces have been deprecated in Eclipse 3.0. Source lookup facilities are now provided by the debug platform - see org.eclipse.debug.core.sourcelookup. Source lookup support specific to the Java debugger is now provided in org.eclipse.jdt.launching.sourcelookup.containers.

org.eclipse.jdt.launching.sourcelookup.containers Package-level Javadoc Provides source lookup support for the Java debugger.

Package Specification

Provides source lookup support for the Java debugger, based on the source lookup director architecture defined in org.eclipse.debug.core.sourcelookup.
org.eclipse.jdt.testplugin
org.eclipse.jdt.testplugin.test
org.eclipse.jdt.testplugin.util
org.eclipse.jdt.ui Package-level Javadoc Application programming interfaces for interaction with the Eclipse Java User Interface.

Package Specification

The package provides support classes for presenting Java elements in the user interface.

The class JavaUI is the main access point to the Java user interface components. It allows to programmatically open editors on Java elements and open package and type prompter dialogs. The package exposes constants for retrieving Java user interface parts from the workbench registry. JavaUI gives access to the IWorkingCopyManager. It manages the working copies that are in use for Java compilation units.

The interfaces ITypeHierarchyViewPart and IPackagesViewPart define the programming interface to interact with the type hierarchy and packages view parts.

The classes JavaElementContentProvider and JavaElementLabelProvider support presenting Java elements in JFace viewers.
 

org.eclipse.jdt.ui.actions Package-level Javadoc Application programming interfaces for Eclipse Java User Interface specific actions.

Package Specification

The package provides actions and action groups to populate tool bars, global menu bars and context menus with JDT specific functionality.

It is recommended that clients use action groups to populate menus and tool bars instead of adding actions directly.

Clients are allowed to instantiate classes from this package. The classes are not intended to be subclassed. All actions and groups require that the selection provided by the site, view part or page passed to the action's or group's constructor is of type org.eclipse.jface.viewers.IStructuredSelection .

org.eclipse.jdt.ui.dialogs Package-level Javadoc Application programming interfaces for dialogs.

Package Specification

The package provides access to the type selection dialog and allows to extend it in certain ways.
org.eclipse.jdt.ui.examples
org.eclipse.jdt.ui.examples.filters
org.eclipse.jdt.ui.jarpackager Package-level Javadoc Provides classes and interfaces to generate a JAR file. This package provides the interfaces and classes for exporting a set of resources to a JAR file via runnable. It offers hooks to extend the JarPackageData to load and store the JarPackageData and to write the JAR itself.

Package Specification

The JarPackageData contains all necessary information to generate a JAR file. This class can be extended to provide additional data or to plug-in a custom JarWriter. The default runnable which creates the JAR can be replaced by implementing IJarExportRunnable. The same applies for the manifest provider (IManifestProvider) and the classes which save (IJarDescriptionWriter) and read (IJarDescriptionReader) the JarPackageData.
org.eclipse.jdt.ui.refactoring Package-level Javadoc Application programming interfaces for rename refactorings.

Package Specification

The package provides access to the rename refactorings provided by JDT. The API supports renaming the following Java elements: IJavaProject, IPackageFragmentRoot, IPackageFragment, ICompilationUnit, IType, ITypeParameter, IMethod, and IField.
org.eclipse.jdt.ui.search Package-level Javadoc Application programming interfaces for Java search participants..

Package Specification

The package provides API that allows clients to participate in Java searches. A Java search query is specified by a QuerySpecification ; an ElementQuerySpecification if searching for a specific IJavaElement , a PatternQuerySpecification when searching for a string pattern.

Clients who want to participate in Java search queries should implement IQueryParticipant. A query participant interprets a QuerySpecification and reports matches to a ISearchRequestor. If a query participant wishes to report matches against elements that are not IResources or IJavaElements, it has to implement a IMatchPresentation to render these elements.

org.eclipse.jdt.ui.tests
org.eclipse.jdt.ui.tests.browsing
org.eclipse.jdt.ui.tests.buildpath
org.eclipse.jdt.ui.tests.callhierarchy
org.eclipse.jdt.ui.tests.core
org.eclipse.jdt.ui.tests.core.source
org.eclipse.jdt.ui.tests.dialogs
org.eclipse.jdt.ui.tests.model
org.eclipse.jdt.ui.tests.packageview
org.eclipse.jdt.ui.tests.quickfix
org.eclipse.jdt.ui.tests.refactoring
org.eclipse.jdt.ui.tests.refactoring.actions
org.eclipse.jdt.ui.tests.refactoring.all
org.eclipse.jdt.ui.tests.refactoring.ccp
org.eclipse.jdt.ui.tests.refactoring.changes
org.eclipse.jdt.ui.tests.refactoring.extensions
org.eclipse.jdt.ui.tests.refactoring.infra
org.eclipse.jdt.ui.tests.refactoring.nls
org.eclipse.jdt.ui.tests.refactoring.reorg
org.eclipse.jdt.ui.tests.refactoring.type
org.eclipse.jdt.ui.tests.refactoring.typeconstraints
org.eclipse.jdt.ui.tests.search
org.eclipse.jdt.ui.tests.wizardapi
org.eclipse.jdt.ui.text Package-level Javadoc Application programming interfaces for interaction with the Eclipse Java User Interface text support.

Package Specification

Support for presenting Java text. The class JavaTextTools provides access to the different scanners to partition and color Java source code. The class JavaSourceViewerConfiguration defines a standard configuration for Java source viewers.
org.eclipse.jdt.ui.text.folding Java Folding Application programming interfaces for interaction with the Eclipse Java Editor folding.

Package Specification

Interfaces and a default implementation for contributions to the org.eclipse.jdt.ui.foldingStructureProviders extension point.
org.eclipse.jdt.ui.text.java Package-level Javadoc Application programming interfaces for interaction with the Eclipse Java User Interface.

Package Specification

Interfaces used with the java doc completion, quick fix and quick assist processor extension points.
org.eclipse.jdt.ui.text.java.hover Package-level Javadoc Application programming interfaces for interaction with the Eclipse Java Editor.

Package Specification

Support for presenting text hovers in Java editors. The interface IJavaEditorTextHover defines the programming interface for a text hover.
org.eclipse.jdt.ui.wizards Package-level Javadoc Application programming interfaces for interaction with the Eclipse Java User Interface wizards.

Package Specification

Provide access to the wizard pages for creating Java elements.
org.eclipse.jface.text.source.translation
org.eclipse.jsp
org.eclipse.jsp.launching
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.