|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
ParseProperty.java | - | - | - | - |
|
1 | /* | |
2 | * Java HTML Tidy - JTidy | |
3 | * HTML parser and pretty printer | |
4 | * | |
5 | * Copyright (c) 1998-2000 World Wide Web Consortium (Massachusetts | |
6 | * Institute of Technology, Institut National de Recherche en | |
7 | * Informatique et en Automatique, Keio University). All Rights | |
8 | * Reserved. | |
9 | * | |
10 | * Contributing Author(s): | |
11 | * | |
12 | * Dave Raggett <dsr@w3.org> | |
13 | * Andy Quick <ac.quick@sympatico.ca> (translation to Java) | |
14 | * Gary L Peskin <garyp@firstech.com> (Java development) | |
15 | * Sami Lempinen <sami@lempinen.net> (release management) | |
16 | * Fabrizio Giustina <fgiust at users.sourceforge.net> | |
17 | * | |
18 | * The contributing author(s) would like to thank all those who | |
19 | * helped with testing, bug fixes, and patience. This wouldn't | |
20 | * have been possible without all of you. | |
21 | * | |
22 | * COPYRIGHT NOTICE: | |
23 | * | |
24 | * This software and documentation is provided "as is," and | |
25 | * the copyright holders and contributing author(s) make no | |
26 | * representations or warranties, express or implied, including | |
27 | * but not limited to, warranties of merchantability or fitness | |
28 | * for any particular purpose or that the use of the software or | |
29 | * documentation will not infringe any third party patents, | |
30 | * copyrights, trademarks or other rights. | |
31 | * | |
32 | * The copyright holders and contributing author(s) will not be | |
33 | * liable for any direct, indirect, special or consequential damages | |
34 | * arising out of any use of the software or documentation, even if | |
35 | * advised of the possibility of such damage. | |
36 | * | |
37 | * Permission is hereby granted to use, copy, modify, and distribute | |
38 | * this source code, or portions hereof, documentation and executables, | |
39 | * for any purpose, without fee, subject to the following restrictions: | |
40 | * | |
41 | * 1. The origin of this source code must not be misrepresented. | |
42 | * 2. Altered versions must be plainly marked as such and must | |
43 | * not be misrepresented as being the original source. | |
44 | * 3. This Copyright notice may not be removed or altered from any | |
45 | * source or altered source distribution. | |
46 | * | |
47 | * The copyright holders and contributing author(s) specifically | |
48 | * permit, without fee, and encourage the use of this source code | |
49 | * as a component for supporting the Hypertext Markup Language in | |
50 | * commercial products. If you use this source code in a product, | |
51 | * acknowledgment is not required but would be appreciated. | |
52 | * | |
53 | */ | |
54 | package org.w3c.tidy; | |
55 | ||
56 | /** | |
57 | * Interface for configuration property parser. | |
58 | * @author Fabrizio Giustina | |
59 | * @version $Revision $ ($Author $) | |
60 | */ | |
61 | public interface ParseProperty | |
62 | { | |
63 | ||
64 | /** | |
65 | * Parse a configuration option. | |
66 | * @param value option value | |
67 | * @param option option name | |
68 | * @param configuration actual configuration instance | |
69 | * @return parsed configuration value | |
70 | */ | |
71 | Object parse(String value, String option, Configuration configuration); | |
72 | ||
73 | /** | |
74 | * Returns the option type. | |
75 | * @return option type | |
76 | */ | |
77 | String getType(); | |
78 | ||
79 | /** | |
80 | * Returns the valid values. | |
81 | * @return valid values (text) | |
82 | */ | |
83 | String getOptionValues(); | |
84 | ||
85 | /** | |
86 | * Returns the "friendly name" for the passed value. Needed to print actual configuration setting. | |
87 | * @param option option name | |
88 | * @param value actual value | |
89 | * @param configuration actual configuration | |
90 | * @return "friendly" actual value | |
91 | */ | |
92 | String getFriendlyName(String option, Object value, Configuration configuration); | |
93 | ||
94 | } |
|