01: /*****************************************************************************
02: * Java Plug-in Framework (JPF)
03: * Copyright (C) 2004-2007 Dmitry Olshansky
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library; if not, write to the Free Software
17: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18: *****************************************************************************/package org.java.plugin.registry;
19:
20: import java.util.Collection;
21:
22: /**
23: * This interface provides access to information about resource or code
24: * contributed by plug-in.
25: * <p>
26: * Library UID is a combination of declaring plug-in ID and library ID that is
27: * unique within whole set of registered plug-ins.
28: * </p>
29: *
30: * @version $Id$
31: */
32: public interface Library extends UniqueIdentity, PluginElement<Library> {
33: /**
34: * @return path to resource
35: */
36: String getPath();
37:
38: /**
39: * @return <code>true</code> if this is "code" library
40: */
41: boolean isCodeLibrary();
42:
43: /**
44: * This method should return collection of {@link String} objects that
45: * represent resource name prefixes or package name patterns that are
46: * available to other plug-ins.
47: * <br>
48: * For code library, prefix is a package name, for resource library,
49: * the same rules applied to relative resource path calculated against
50: * library path (you can replace slash characters in path with dots).
51: * <br>
52: * Example prefixes are:<br>
53: * <code>
54: * "*", "package.name.*", "package.name.ClassName", "resource/path/*
55: * </code>
56: * @return collection of exported resource name patterns
57: */
58: Collection<String> getExports();
59:
60: /**
61: * @return library version identifier as specified in manifest file or
62: * <code>null</code>
63: */
64: Version getVersion();
65: }
|