NamedComponentReference


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.xml.xam.dom;
21  
22  import javax.xml.namespace.QName  ;
23  import org.netbeans.modules.xml.xam.NamedReferenceable;
24  import org.netbeans.modules.xml.xam.Reference;
25  
26  /**
27   * Represents reference to a component that can be identified globally by QName.
28   *
29   * @author Chris Webster
30   * @author Rico Cruz
31   * @author Nam Nguyen
32   */
33  public interface NamedComponentReference<T extends NamedReferenceable> extends Reference<T> {
34      
35      /**
36       * Returns the effective namespace of the referenced component.
37       * <p>
38       * Note that in case of XML schema document, the effective namespace of a 
39       * component could be different when the schema is included by another schema.
40       *
41       * @return referenced namespace that is effective in the current document.
42       */
43      String   getEffectiveNamespace();
44      
45      /**
46       * Returns full QName of the referenced component if the reference is not broken.
47       * If reference has not been resolved or broken, the returned QNam could be 
48       * partial (only local name) and implementation dependent.
49       * @return QName of the referenced component.
50       */
51      QName   getQName();
52  }
53
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags