KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > jmi > javamodel > IsOfType


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.jmi.javamodel;
21
22 /**
23  * IsOfType association proxy interface.
24  * Associates typed element with a type.
25  *
26  * <p><em><strong>Note:</strong> This type should not be subclassed or implemented
27  * by clients. It is generated from a MOF metamodel and automatically implemented
28  * by MDR (see <a HREF="http://mdr.netbeans.org/">mdr.netbeans.org</a>).</em></p>
29  */
30 public interface IsOfType extends javax.jmi.reflect.RefAssociation {
31     /**
32      * Queries whether a link currently exists between a given pair of instance
33      * objects in the associations link set.
34      * @param type Value of the first association end.
35      * @param typedElements Value of the second association end.
36      * @return Returns true if the queried link exists.
37      */
38     public boolean exists(org.netbeans.jmi.javamodel.Type type, org.netbeans.jmi.javamodel.TypedElement typedElements);
39     /**
40      * Queries the instance object that is related to a particular instance object
41      * by a link in the current associations link set.
42      * @param typedElements Required value of the second association end.
43      * @return Related object or <code>null</code> if none exists.
44      */
45     public org.netbeans.jmi.javamodel.Type getType(org.netbeans.jmi.javamodel.TypedElement typedElements);
46     /**
47      * Queries the instance objects that are related to a particular instance
48      * object by a link in the current associations link set.
49      * @param type Required value of the first association end.
50      * @return Collection of related objects.
51      */
52     public java.util.Collection JavaDoc getTypedElements(org.netbeans.jmi.javamodel.Type type);
53     /**
54      * Creates a link between the pair of instance objects in the associations
55      * link set.
56      * @param type Value of the first association end.
57      * @param typedElements Value of the second association end.
58      */
59     public boolean add(org.netbeans.jmi.javamodel.Type type, org.netbeans.jmi.javamodel.TypedElement typedElements);
60     /**
61      * Removes a link between a pair of instance objects in the current associations
62      * link set.
63      * @param type Value of the first association end.
64      * @param typedElements Value of the second association end.
65      */
66     public boolean remove(org.netbeans.jmi.javamodel.Type type, org.netbeans.jmi.javamodel.TypedElement typedElements);
67 }
68
Popular Tags