01: /*
02: * This file is part of "SnipSnap Radeox Rendering Engine".
03: *
04: * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
05: * All Rights Reserved.
06: *
07: * Please visit http://radeox.org/ for updates and contact.
08: *
09: * --LICENSE NOTICE--
10: * Licensed under the Apache License, Version 2.0 (the "License");
11: * you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software
17: * distributed under the License is distributed on an "AS IS" BASIS,
18: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19: * See the License for the specific language governing permissions and
20: * limitations under the License.
21: * --LICENSE NOTICE--
22: */
23:
24: package org.radeox.macro.api;
25:
26: import java.io.IOException;
27: import java.io.Writer;
28:
29: /**
30: * Converts a class name to an API url
31: *
32: * @author Stephan J. Schmidt
33: * @version $Id: ApiConverter.java 7756 2006-04-13 12:25:49Z ian@caret.cam.ac.uk $
34: */
35:
36: public interface ApiConverter {
37: /**
38: * Converts a class name to an url and adds the url to an Writer. The url
39: * usually shows som API information about the class e.g. for Java classes
40: * this points to the API documentation on the Sun site.
41: *
42: * @param writer
43: * Writer to add the class url to
44: * @param className
45: * Namee of the class to create pointer for
46: */
47: public void appendUrl(Writer writer, String className)
48: throws IOException;
49:
50: /**
51: * Set the base Url for the Converter. A converter creates an API pointer by
52: * combining an base url and the name of a class.
53: *
54: * @param baseUrl
55: * Url to use when creating an API pointer
56: */
57: public void setBaseUrl(String baseUrl);
58:
59: /**
60: * Get the base Url for the Converter. A converter creates an API pointer by
61: * combining an base url and the name of a class.
62: *
63: * @return baseUrl Url the converter uses when creating an API pointer
64: */
65: public String getBaseUrl();
66:
67: /**
68: * Returns the name of the converter. This is used to configure the BaseUrls
69: * and associate them with a concrete converter.
70: *
71: * @return name Name of the Converter, e.g. Java12
72: */
73: public String getName();
74: }
|