blob: a4287558bc6138bec0911a728cb25f2f87759659 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) 2005-2007 BEA Systems, Inc. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html" >
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>
Automatic Processor Options
</title>
</head>
<body>
<h1>
Automatic Processor Options
</h1>
<p>Annotation processor options are configured in the
<a href="ref-apt-config.htm">Annotation Processing preference dialog</a>. Certain options are automatically
provided to the processors (for Java 5 processors; entering them in this dialog will have no effect, since
the automatically provided values will override any values set here), or provided to the processors as
variables (for Java 6 processors, see details below). The automatic options include the following:</p>
<dl>
<dt><strong>-classpath</strong></dt>
<dd>
The compiler classpath. All entries are absolute paths, not workspace-relative.
</dd>
<dt><strong>-sourcepath</strong></dt>
<dd>
The compiler source path. All entries are absolute paths, not workspace-relative.
</dd>
<dt><strong>-d</strong></dt>
<dd>
The absolute path of the compiler binary output directory, into which .class files are
built.
</dd>
<dt><strong>-s</strong></dt>
<dd>
The absolute path of the generated source directory, into which annotation processors
will generate files.
</dd>
<dt><strong>-source</strong></dt>
<dd>
The compiler -source option. Typically a string such as &quot;5.0&quot;.
</dd>
<dt><strong>-target</strong></dt>
<dd>
The compiler -target option. Typically a string such as &quot;5.0&quot;.
</dd>
<dt><strong>phase</strong></dt>
<dd>
The string <code>RECONCILE</code>, <code>BUILD</code>, or <code>OTHER</code>, depending
on whether the processor has been called during editing, during a build, or outside the
context of compilation, respectively. This option is only provided when running in the Eclipse IDE.
</dd>
</dl>
<p>Except for <code>phase</code>, there are no automatically provided options for processors
using the Java 6 annotation processing API, where JavaFileManager methods provide similar functionality.
However, the values of the automatic options are made available to Java 6 processors as variables like
<code>%classpath%</code> or <code>%sourcepath%</code> when
<a href="ref-apt-processorOptionsInput.htm">setting up processor options</a>.</p>
</body>
</html>