4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9
SezPoz is a lightweight and simple-to-learn library that lets you perform modular service lookups.
10
It provides some of the same capabilities as (for example) <code>java.util.ServiceLoader</code>,
11
Eclipse extension points, and NetBeans <code>Lookup</code> and XML layers.
12
However, SezPoz has some special advantages:
17
The service registrations are made just using type-checked Java annotations.
18
There are no configuration files to edit, and your Java IDE can show you registrations since they are simply usages of an annotation.
19
On JDK 6, no special build or packaging steps are required (just javac); on JDK 5, you just need to run APT (with default arguments),
20
instead of or in addition to javac for any sources which may contain indexable items.
21
Looking up services just requires that you have a <code>ClassLoader</code> which can "see" all of the "modules" (as with <code>ServiceLoader</code>).
26
You can register individual objects (values of static fields or methods) instead of whole classes.
31
You can associate static metadata with each implementation, using regular annotation values.
32
The caller can choose to inspect the metadata without loading the actual implementation object (as with Eclipse extension points).
37
(Why the name? SezPoz "says" the "position" of your services. It is also a
38
"<a href="http://slovnik.seznam.cz/search.py?wd=seznam&lg=cz_en">seznam</a>
39
<a href="http://slovnik.seznam.cz/search.py?wd=pozn%C3%A1mka&lg=cz_en">poznámek</a>".)
42
<h1>Sources and Binaries</h1>
44
Sources are in the form of Maven projects. To build:
50
To try the demo application:
53
mvn -f demo/app/pom.xml exec:exec
56
Binaries, sources, and Javadoc can all be downloaded from the
57
<a href="http://download.java.net/maven/2/net/java/sezpoz/sezpoz/">Maven repository</a>.
60
For usage from Maven applications, add the java.net repository
61
(<a href="https://maven2-repository.dev.java.net/">details</a>)
62
and use the artifact <code>net.java.sezpoz:sezpoz</code>, for example:
67
<id>maven2-repository.dev.java.net</id>
68
<name>Java.net Repository for Maven</name>
69
<url>http://download.java.net/maven/2/</url>
74
<groupId>net.java.sezpoz</groupId>
75
<artifactId>sezpoz</artifactId>
76
<version>1.7</version>
81
<h1>Usage Summary</h1>
83
See Javadoc for details on particular classes, or just look at
84
<a href="http://download.java.net/maven/2/net/java/sezpoz/demo/">demo sources</a>.
87
Support for declaring, creating, and inspecting indices of annotated Java elements.
89
For example, to permit registration of simple menu items, while
90
making it possible to prepare a menu without loading any of them
91
until they are actually selected:
93
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
94
@Retention(RetentionPolicy.SOURCE)
95
@Indexable(type=ActionListener.class)
96
public @interface MenuItem {
99
String iconPath() default "";
102
A concrete registration might look like:
104
@MenuItem(menuName="File", itemName="Print", iconPath=".../print.png")
105
public class PrintAction extends AbstractAction {
106
public void actionPerformed(ActionEvent e) {...}
111
public class Actions {
112
@MenuItem(menuName="File", itemName="Print")
113
public static Action print() {...}
118
public class Actions {
119
@MenuItem(menuName="File", itemName="Print")
120
public static final Action PRINT = ...;
123
To create the index on JDK 6, just compile your sources normally with javac.
124
If using JDK 5, simply run apt instead of/in addition to javac.
125
(The processor is in the same JAR as this API and should be autodetected.)
127
Usage is then simple:
129
for (final IndexItem<MenuItem,ActionListener> item :
130
Index.load(MenuItem.class, ActionListener.class)) {
131
JMenu menu = new JMenu(item.annotation().menuName());
132
JMenuItem menuitem = new JMenuItem(item.annotation().itemName());
133
String icon = item.annotation().iconPath();
134
if (!icon.equals("")) {
135
menuitem.setIcon(new ImageIcon(icon));
137
menuitem.addActionListener(new ActionListener() {
138
public void actionPerformed(ActionEvent e) {
140
item.instance().actionPerformed(e);
141
} catch (InstantiationException x) {
154
<li><p>When using JDK 5 and apt, incremental compilation can result in an index file being generated with only some
155
of the desired entries, if other source files are omitted e.g. by Ant.
157
This scenario works better using JDK 6's javac: if you compile just some sources which are marked with an indexable annotation,
158
these entries will be appended to any existing registrations from previous runs of the compiler.
159
(You should run a clean build if you <em>delete</em> annotations from sources.)
161
<li><p>The Java language spec currently prohibits recursive annotation definitions,
162
although as of this writing javac does not.
163
See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6264216">bug #6264216</a>.</p></li>
167
Eclipse-specific notes: make sure annotation processing is enabled at least for any
168
projects registering objects using annotations. Make sure the SezPoz library is
169
in the factory path for annotation processors. You also need to check the box
170
<b>Run this container's processor in batch mode</b> from the <b>Advanced</b>
171
button in <b>Java Compiler > Annotation Processing > Factory Path</b>.
172
There does not appear to be any way for Eclipse to discover processors
173
in the regular classpath as JSR 269 suggests, and there does not appear to be
174
any way to make these settings apply automatically to all projects.
175
Eclipse users are recommended to use javac (e.g. via Maven) to build.
176
<a href="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.jdt.doc.isv/guide/jdt_apt_getting_started.htm">Eclipse Help Page</a>
177
<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=280542">Eclipse bug #280542</a>
182
<!-- perhaps mention: http://wiki.glassfish.java.net/Wiki.jsp?page=DependencyMechanism -->
183
<!-- similar to Eclipse: http://jpf.sourceforge.net/ -->
184
<!-- can mention that Hudson now uses it -->
185
<!-- investigate interoperability with Peaberry -->
added
removed
www/index.html
