org.eclipse.jst.ws.annotations.core.processor
Class AbstractAnnotationProcessor

java.lang.Object
  org.eclipse.jst.ws.annotations.core.processor.AbstractAnnotationProcessor

All Implemented Interfaces:

com.sun.mirror.apt.AnnotationProcessor

public abstract class AbstractAnnotationProcessor
extends java.lang.Object
implements com.sun.mirror.apt.AnnotationProcessor

Abstract base class for processors contributed to the org.eclipse.jst.ws.annotations.core.annotationProcessor extension point.

Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Field Summary

protected com.sun.mirror.apt.AnnotationProcessorEnvironment

environment

Constructor Summary

protected

AbstractAnnotationProcessor()

Method Summary

protected void	printError(com.sun.mirror.util.SourcePosition position, java.lang.String message) Prints an error message.
protected void	printError(java.lang.String message) Prints an error message.
protected void	printFixableError(com.sun.mirror.util.SourcePosition position, java.lang.String message) Print an error including the given arguments for use in quick-fixes.
protected void	printFixableError(com.sun.mirror.util.SourcePosition position, java.lang.String message, java.lang.String pluginId, java.lang.String errorId) Print an error including the given arguments for use in quick-fixes.
protected void	printFixableError(java.lang.String message, java.lang.String pluginId, java.lang.String errorId) Print an error including the given arguments for use in quick-fixes.
protected void	printFixableNotice(com.sun.mirror.util.SourcePosition position, java.lang.String message, java.lang.String pluginId, java.lang.String errorId) Print a notice including the given arguments for use in quick-fixes.
protected void	printFixableNotice(java.lang.String message, java.lang.String pluginId, java.lang.String errorId) Print a notice including the given arguments for use in quick-fixes.
protected void	printFixableWarning(com.sun.mirror.util.SourcePosition position, java.lang.String message, java.lang.String pluginId, java.lang.String errorId) Print a warning including the given arguments for use in quick-fixes.
protected void	printFixableWarning(java.lang.String message, java.lang.String pluginId, java.lang.String errorId) Print a warning including the given arguments for use in quick-fixes.
protected void	printNotice(com.sun.mirror.util.SourcePosition position, java.lang.String message) Prints a notice.
protected void	printNotice(java.lang.String message) Prints a notice.
protected void	printWarning(com.sun.mirror.util.SourcePosition position, java.lang.String message) Prints a warning message.
protected void	printWarning(java.lang.String message) Prints a warning message.
abstract void	process() Process all program elements supported by this annotation processor.
void	setAnnotationProcessorEnvironment(com.sun.mirror.apt.AnnotationProcessorEnvironment environment) Set the AnnotationProcessorEnvironment environment to use during processing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

environment

protected com.sun.mirror.apt.AnnotationProcessorEnvironment environment

Constructor Detail

AbstractAnnotationProcessor

protected AbstractAnnotationProcessor()

Method Detail

setAnnotationProcessorEnvironment

public void setAnnotationProcessorEnvironment(com.sun.mirror.apt.AnnotationProcessorEnvironment environment)

Set the AnnotationProcessorEnvironment environment to use during processing.

Parameters:

environment - the annotation processor environment.

process

public abstract void process()

Process all program elements supported by this annotation processor.

Specified by:

process in interface com.sun.mirror.apt.AnnotationProcessor

See Also:

AnnotationProcessor

printError

protected void printError(com.sun.mirror.util.SourcePosition position,
                          java.lang.String message)

Prints an error message.

Parameters:

position - the position where the error occured, or null if it is unknown or not applicable

message - the message, or an empty string if none

printError

protected void printError(java.lang.String message)

Prints an error message.

Parameters:

message - the message, or an empty string if none

printWarning

protected void printWarning(com.sun.mirror.util.SourcePosition position,
                            java.lang.String message)

Prints a warning message.

Parameters:

position - the position where the warning occured, or null if it is unknown or not applicable

message - the message, or an empty string if none

printWarning

protected void printWarning(java.lang.String message)

Prints a warning message.

Parameters:

message - the message, or an empty string if none

printNotice

protected void printNotice(com.sun.mirror.util.SourcePosition position,
                           java.lang.String message)

Prints a notice.

Parameters:

position - the position where the notice occured, or null if it is unknown or not applicable

message - the message, or an empty string if none

printNotice

protected void printNotice(java.lang.String message)

Prints a notice.

Parameters:

message - the message, or an empty string if none

printFixableError

protected void printFixableError(com.sun.mirror.util.SourcePosition position,
                                 java.lang.String message)

Print an error including the given arguments for use in quick-fixes.

Parameters:

position - position of the error

message - message to display to the user

printFixableError

protected void printFixableError(com.sun.mirror.util.SourcePosition position,
                                 java.lang.String message,
                                 java.lang.String pluginId,
                                 java.lang.String errorId)

Print an error including the given arguments for use in quick-fixes.

Parameters:

position - position of the error

message - message to display to the user

pluginId - plug-in which will provide a java quick fix processor for this error. Cannot be null.

errorId - a plug-in provided error code which will be meaningful to the java quick fix processor. Cannot be null.

printFixableError

protected void printFixableError(java.lang.String message,
                                 java.lang.String pluginId,
                                 java.lang.String errorId)

Print an error including the given arguments for use in quick-fixes.

Parameters:

message - message to display to the user

pluginId - plug-in which will provide a java quick fix processor for this error. Cannot be null.

errorId - a plug-in provided error code which will be meaningful to the java quick fix processor. Cannot be null.

printFixableWarning

protected void printFixableWarning(com.sun.mirror.util.SourcePosition position,
                                   java.lang.String message,
                                   java.lang.String pluginId,
                                   java.lang.String errorId)

Print a warning including the given arguments for use in quick-fixes.

Parameters:

position - position of the warning

message - message to display to the user

pluginId - plug-in which will provide a java quick fix processor for this error. Cannot be null.

errorId - a plug-in provided error code which will be meaningful to the java quick fix processor. Cannot be null.

printFixableWarning

protected void printFixableWarning(java.lang.String message,
                                   java.lang.String pluginId,
                                   java.lang.String errorId)

Print a warning including the given arguments for use in quick-fixes.

Parameters:

message - message to display to the user

pluginId - plug-in which will provide a java quick fix processor for this error. Cannot be null.

errorId - a plug-in provided error code which will be meaningful to the java quick fix processor. Cannot be null.

printFixableNotice

protected void printFixableNotice(com.sun.mirror.util.SourcePosition position,
                                  java.lang.String message,
                                  java.lang.String pluginId,
                                  java.lang.String errorId)

Print a notice including the given arguments for use in quick-fixes.

Parameters:

position - position of the notice

message - message to display to the user

pluginId - plug-in which will provide a java quick fix processor for this error. Cannot be null.

errorId - a plug-in provided error code which will be meaningful to the java quick fix processor. Cannot be null.

printFixableNotice

protected void printFixableNotice(java.lang.String message,
                                  java.lang.String pluginId,
                                  java.lang.String errorId)

Print a notice including the given arguments for use in quick-fixes.

Parameters:

message - message to display to the user

pluginId - plug-in which will provide a java quick fix processor for this error. Cannot be null.

errorId - a plug-in provided error code which will be meaningful to the java quick fix processor. Cannot be null.