KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > xam > Reference


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;
21
22 /**
23  * Represents reference to a component. On writing, this indirection help serialize
24  * the referenced component as an attribute string value. On reading, the referenced
25  * can be resolved on demand.
26  * <p>
27  * Note: Client code should always check for brokeness before access the referenced.
28  *
29  * @author Chris Webster
30  * @author Rico Cruz
31  * @author Nam Nguyen
32  */

33
34 public interface Reference<T extends Referenceable> {
35     /**
36      * @return the referenced component. May return null if
37      * #isBroken() returns true;
38      */

39     T get();
40     
41     /**
42      * Returns type of the referenced.
43      */

44     Class JavaDoc<T> getType();
45
46     /**
47      * Returns true if the reference cannot be resolved in the current document
48      */

49     boolean isBroken();
50     
51     /**
52      * Returns true if this reference refers to target.
53      * <p>
54      * Note: In some implementation, this method could be more efficient than
55      * invoking #get() for direct checking.
56      */

57     boolean references(T target);
58     
59     /**
60      * @return string to use in persiting the reference as attribute string value
61      * of the containing component
62      */

63     String JavaDoc getRefString();
64 }
65
Popular Tags