This repository has been archived by the owner on Nov 5, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
javadoc-overview.html
56 lines (53 loc) · 2.18 KB
/
javadoc-overview.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Overview</title>
</head>
<body>
<p>Provides interfaces for embossing, creating and manipulating
PEF-files. The API supports both SPI and OSGi runtime contexts.</p>
<h2>Providing implementations</h2>
<p>The following interfaces have been constructed so that they can
be discovered as SPI and OSGi services:</p>
<ul>
<li>org.daisy.braille.utils.api.embosser.EmbosserProvider</li>
<li>org.daisy.braille.utils.api.embosser.EmbosserCatalogService</li>
<li>org.daisy.braille.utils.api.table.TableProvider</li>
<li>org.daisy.braille.utils.api.table.TableCatalogService</li>
<li>org.daisy.braille.utils.api.paper.PaperProvider</li>
<li>org.daisy.braille.utils.api.paper.PaperCatalogService</li>
<li>org.daisy.braille.utils.api.validator.ValidatorProvider</li>
<li>org.daisy.braille.utils.api.validator.ValidatorFactoryService</li>
</ul>
<p>
While all of the above <em>may</em> be discovered by SPI or OSGi, the
following interfaces provide a starting point for a developer who
wishes to add support for additional embossers:
</p>
<ul>
<li>org.daisy.braille.utils.api.embosser.EmbosserProvider</li>
<li>org.daisy.braille.utils.api.table.TableProvider</li>
<li>org.daisy.braille.utils.api.paper.PaperProvider</li>
</ul>
<h2>Implementations bundled with the API</h2>
<p>Default implementations of the following interfaces are
included:</p>
<ul>
<li>org.daisy.braille.utils.api.embosser.EmbosserCatalogService</li>
<li>org.daisy.braille.utils.api.paper.PaperCatalogService</li>
<li>org.daisy.braille.utils.api.table.TableCatalogService</li>
<li>org.daisy.braille.utils.api.validator.ValidatorFactoryService</li>
</ul>
<p>In an OSGi context, an implementation is retrieved from the service
registry using these interfaces.</p>
<p>In an SPI context, the implementations can be accessed
directly:</p>
<ul>
<li>org.daisy.braille.utils.api.embosser.EmbosserCatalog</li>
<li>org.daisy.braille.utils.api.paper.PaperCatalog</li>
<li>org.daisy.braille.utils.api.table.TableCatalog</li>
<li>org.daisy.braille.utils.api.validator.ValidatorFactory</li>
</ul>
</body>
</html>