01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.modules.gsfpath.spi.classpath;
42:
43: import java.beans.PropertyChangeListener;
44: import java.net.URL;
45:
46: /**
47: * SPI interface for one classpath entry.
48: * @see ClassPathImplementation
49: * @since org.netbeans.modules.gsfpath.api/1 1.4
50: */
51: public interface PathResourceImplementation {
52:
53: public static final String PROP_ROOTS = "roots"; //NOI18N
54:
55: /** Roots of the class path entry.
56: * In the case of simple resource it returns array containing just one URL.
57: * In the case of composite resource it returns array containing one or more URL.
58: * @return array of URL, never returns null.
59: */
60: public URL[] getRoots();
61:
62: /**
63: * Returns ClassPathImplementation representing the content of the PathResourceImplementation.
64: * If the PathResourceImplementation represents leaf resource, it returns null.
65: * The ClassPathImplementation is live and can be used for path resource content
66: * modification.
67: * <p><strong>Semi-deprecated.</strong> There was never a real reason for this method to exist.
68: * If implementing <code>PathResourceImplementation</code> you can simply return null;
69: * it is unlikely anyone will call this method anyway.
70: * @return classpath handle in case of composite resource; null for leaf resource
71: */
72: public ClassPathImplementation getContent();
73:
74: /**
75: * Adds property change listener.
76: * The listener is notified when the roots of the entry are changed.
77: * @param listener
78: */
79: public void addPropertyChangeListener(
80: PropertyChangeListener listener);
81:
82: /**
83: * Removes property change listener.
84: * @param listener
85: */
86: public void removePropertyChangeListener(
87: PropertyChangeListener listener);
88:
89: }
|