001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.openide.cookies;
043:
044: import java.io.IOException;
045: import org.openide.nodes.Node;
046:
047: /**
048: * Cookie that should be provided by all nodes that are able
049: * to create a "instance".
050: * Generally this is used to register objects declaratively in XML layers.
051: *
052: * @author Jaroslav Tulach
053: */
054: public interface InstanceCookie/*<T>*/extends Node.Cookie {
055:
056: /**
057: * The name of {@link #instanceClass}.
058: * Should be the same as <code>instanceClass().getName()</code>
059: * but may be able to avoid actually loading the class.
060: * @return the instance class name
061: */
062: public String instanceName();
063:
064: /**
065: * The type that the instance is expected to be assignable to.
066: * Can be used to test whether the instance is of an appropriate
067: * class without actually creating it.
068: *
069: * @return the type (or perhaps some interesting supertype) of the instance
070: * @exception IOException if metadata about the instance could not be read, etc.
071: * @exception ClassNotFoundException if the instance type could not be loaded
072: */
073: public Class<?/*T*/> instanceClass() throws IOException,
074: ClassNotFoundException;
075:
076: /**
077: * Create an instance.
078: * @return an object assignable to {@link #instanceClass}
079: * @throws IOException for the same reasons as {@link #instanceClass}, or an object could not be deserialized, etc.
080: * @throws ClassNotFoundException for the same reasons as {@link #instanceClass}
081: */
082: public Object/*T*/instanceCreate() throws IOException,
083: ClassNotFoundException;
084:
085: /**
086: * Enhanced cookie that can answer queries about the type of the
087: * instance it creates. It does not add any additional ability except to
088: * improve performance, because it is not necessary to load
089: * the actual class of the object into memory.
090: *
091: * @since 1.4
092: */
093: public interface Of extends InstanceCookie {
094: /**
095: * Checks if the object created by this cookie is an
096: * instance of the given type. The same as
097: * <code>type.isAssignableFrom(instanceClass())</code>
098: * But this can prevent the actual class from being
099: * loaded into the Java VM.
100: *
101: * @param type the class type we want to check
102: * @return true if this cookie will produce an instance of the given type
103: */
104: public boolean instanceOf(Class<?> type);
105: }
106:
107: }
|