~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to xml/xam/src/org/netbeans/modules/xml/xam/dom/NamedComponentReference.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
ImportĀ upstreamĀ versionĀ 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "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
 
 
42
package org.netbeans.modules.xml.xam.dom;
 
43
 
 
44
import javax.xml.namespace.QName;
 
45
import org.netbeans.modules.xml.xam.NamedReferenceable;
 
46
import org.netbeans.modules.xml.xam.Reference;
 
47
 
 
48
/**
 
49
 * Represents reference to a component that can be identified globally by QName.
 
50
 *
 
51
 * @author Chris Webster
 
52
 * @author Rico Cruz
 
53
 * @author Nam Nguyen
 
54
 */
 
55
public interface NamedComponentReference<T extends NamedReferenceable> extends Reference<T> {
 
56
    
 
57
    /**
 
58
     * Returns the effective namespace of the referenced component.
 
59
     * <p>
 
60
     * Note that in case of XML schema document, the effective namespace of a 
 
61
     * component could be different when the schema is included by another schema.
 
62
     *
 
63
     * @return referenced namespace that is effective in the current document.
 
64
     */
 
65
    String getEffectiveNamespace();
 
66
    
 
67
    /**
 
68
     * Returns full QName of the referenced component if the reference is not broken.
 
69
     * If reference has not been resolved or broken, the returned QNam could be 
 
70
     * partial (only local name) and implementation dependent.
 
71
     * @return QName of the referenced component.
 
72
     */
 
73
    QName getQName();
 
74
}