ExternalReferenceNode


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-2007 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.xml.xam.ui.customizer;
21  
22  import org.netbeans.modules.xml.xam.Model;
23  import org.openide.nodes.Node;
24  
25  /**
26   * Nodes within ExternalReferenceCustomizer should implement this interface
27   * to provide information about the data they represent.
28   *
29   * @author  Nathan Fiedler
30   */
31  public interface ExternalReferenceNode {
32  
33      /**
34       * Get a cookie for this node.
35       *
36       * @param  type  the representation class of the cookie.
37       * @return  a cookie assignable to that class, or null if this node
38       *          has no such cookie.
39       */
40      <T extends Node.Cookie> T getCookie(Class  <T> type);
41  
42      /**
43       * Returns the Model associated with this node, if it has one.
44       *
45       * @return  XAM model, or null if none or invalid.
46       * @see #hasModel
47       */
48      Model getModel();
49  
50      /**
51       * Returns the namespace for this node. If the node represents a file,
52       * the value is the namespace for that file. If the node represents a
53       * namespace, the value is that namespace.
54       *
55       * @return  namespace for this node, or null if none.
56       */
57      String   getNamespace();
58  
59      /**
60       * Indicates if this node represents a file that has a model. Even if
61       * the model is not valid (i.e. the file is not well formed), this will
62       * return true.
63       *
64       * @return  true if node represents a model, false otherwise.
65       */
66      boolean hasModel();
67  }
68
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags