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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*****************************************************************************
* Java Plug-in Framework (JPF)
* Copyright (C) 2004-2007 Dmitry Olshansky
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*****************************************************************************/
package org.java.plugin.registry;
import java.net.URL;
import java.util.Collection;
import java.util.Date;
import org.java.plugin.PathResolver;
import org.java.plugin.registry.ExtensionPoint.ParameterDefinition;
/**
* This interface abstracts an extension - particular functionality,
* the plug-in contribute to the system.
* <p>
* Extension UID is a combination of declaring plug-in ID and extension ID that
* is unique within whole set of registered plug-ins.
* </p>
*
* @version $Id$
*/
public interface Extension extends UniqueIdentity, PluginElement<Extension> {
/**
* Returns collection of all top level parameters defined in this extension.
* @return collection of {@link Extension.Parameter} objects
*/
Collection<Parameter> getParameters();
/**
* Returns top level parameter with given ID or <code>null</code> if no top
* level parameters exist. If more than one top level parameters with given
* ID found, the method should throw an {@link IllegalArgumentException}.
* @param id ID of parameter to look for
* @return top level parameter with given ID
*/
Parameter getParameter(String id);
/**
* @param id ID of parameter to look for
* @return collection of all top level parameters with given ID
*/
Collection<Parameter> getParameters(String id);
/**
* @return ID of plug-in, extended point belongs to
*/
String getExtendedPluginId();
/**
* @return ID of extended point
*/
String getExtendedPointId();
/**
* @return <code>true</code> if extension is considered to be valid
*/
boolean isValid();
/**
* This interface abstracts extension parameter according to extension
* declaration in manifest.
* @version $Id$
*/
interface Parameter extends PluginElement<Parameter> {
/**
* @return parameter value as it is specified in manifest, if no value
* provided there, this method should return empty string
*/
String rawValue();
/**
* Returns collection of all sub-parameters defined in this parameter.
* @return collection of {@link Extension.Parameter} objects
*/
Collection<Parameter> getSubParameters();
/**
* Returns sub-parameter with given ID or <code>null</code> if no
* sub-parameters exist. If more than one sub-parameters with given ID
* found, the method should throw an {@link IllegalArgumentException}.
* @param id ID of sub-parameter to look for
* @return sub-parameter with given ID
*/
Parameter getSubParameter(String id);
/**
* @param id ID of sub-parameter to look for
* @return collection of all sub-parameters with given ID
*/
Collection<Parameter> getSubParameters(String id);
/**
* @return extension this parameter belongs to
*/
Extension getDeclaringExtension();
/**
* Returns definition for this extension parameter.
* May return <code>null</code> for "invalid" parameters.
* @return parameter definition or <code>null</code>, if this parameter
* is "invalid"
*/
ParameterDefinition getDefinition();
/**
* @return parameter, of which this one is child or <code>null</code> if
* this is top level parameter
*/
Parameter getSuperParameter();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#STRING}, this method
* should throw an {@link UnsupportedOperationException}.
* @return value as String object
*/
String valueAsString();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#BOOLEAN}, this method
* should throw an {@link UnsupportedOperationException}.
* @return value as Boolean object
*/
Boolean valueAsBoolean();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#NUMBER}, this method
* should throw an {@link UnsupportedOperationException}.
* @return value as Number object
*/
Number valueAsNumber();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#DATE}, {@link ParameterType#TIME}
* or {@link ParameterType#DATE_TIME}, this method should throw an
* {@link UnsupportedOperationException}.
* @return value as Date object
*/
Date valueAsDate();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#PLUGIN_ID}, this
* method should throw an {@link UnsupportedOperationException}.
* @return value as PluginDescriptor object
*/
PluginDescriptor valueAsPluginDescriptor();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#EXTENSION_POINT_ID},
* this method should throw an {@link UnsupportedOperationException}.
* @return value as ExtensionPoint object
*/
ExtensionPoint valueAsExtensionPoint();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#EXTENSION_ID}, this
* method should throw an {@link UnsupportedOperationException}.
* @return value as Extension object
*/
Extension valueAsExtension();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#RESOURCE}, this
* method should throw an {@link UnsupportedOperationException}.
* @return value as absolute or relative URL as specified in manifest
*/
URL valueAsUrl();
/**
* Returns "typed" value of parameter. If this parameter is invalid or
* is not of type {@link ParameterType#RESOURCE}, this
* method should throw an {@link UnsupportedOperationException}.
* @param pathResolver path resolver to make URL absolute
* @return value as absolute URL
*/
URL valueAsUrl(PathResolver pathResolver);
}
}
|
