diff options
author | fitzsim <fitzsim@138bc75d-0d04-0410-961f-82ee72b054a4> | 2007-03-13 05:48:03 +0000 |
---|---|---|
committer | fitzsim <fitzsim@138bc75d-0d04-0410-961f-82ee72b054a4> | 2007-03-13 05:48:03 +0000 |
commit | f320685c2f28be86b362cdc99454c967fcaa64db (patch) | |
tree | 990fd86bf6b013d5491baa12df0c10d63975e50c /libjava/classpath/tools/com/sun/javadoc/ClassDoc.java | |
parent | 02b0f3d552485e44710d4984843866854c40ee15 (diff) | |
download | ppe42-gcc-f320685c2f28be86b362cdc99454c967fcaa64db.tar.gz ppe42-gcc-f320685c2f28be86b362cdc99454c967fcaa64db.zip |
2007-03-13 Thomas Fitzsimmons <fitzsim@redhat.com>
* Makefile.am (AM_CXXFLAGS): Define ECJ_JAR_FILE.
* classpath/configure.ac: Add --with-ecj-jar configure option.
* classpath/gnu/classpath/Configuration.java.in (ECJ_JAR): New
field.
* classpath/INSTALL: Document --with-ecj-jar configure option and
ecj jar requirement for com.sun.tools.javac support.
* classpath/tools/Makefile.am: Build decendents of com and sun
directories.
* configure.ac: Substitute ECJ_JAR in stub Configuration.java.
* gnu/classpath/Configuration.java,
gnu/classpath/natConfiguration.cc (ecj): New method.
(ECJ_JAR): New field.
* scripts/makemake.tcl (scan_packages): Add com directory.
* sources.am (property_files): Add
classpath/resource/sun/rmi/rmic/messages.properties and
classpath/resource/com/sun/tools/javac/messages.properties.
* classpath/resource/com, classpath/resource/com/sun,
classpath/resource/com/sun/tools,
classpath/resource/com/sun/tools/javac, classpath/resource/sun,
classpath/resource/sun/rmi, classpath/resource/sun/rmi/rmic,
classpath/tools/classes/com, classpath/tools/classes/com/sun,
classpath/tools/classes/com/sun/javadoc,
classpath/tools/classes/com/sun/tools,
classpath/tools/classes/com/sun/tools/doclets,
classpath/tools/classes/sun, classpath/tools/classes/sun/rmi,
classpath/tools/classes/sun/rmi/rmic, classpath/tools/com,
classpath/tools/com/sun, classpath/tools/com/sun/javadoc,
classpath/tools/com/sun/tools,
classpath/tools/com/sun/tools/doclets,
classpath/tools/com/sun/tools/javac, classpath/tools/sun,
classpath/tools/sun/rmi, classpath/tools/sun/rmi/rmic: New
directories.
* classpath/resource/com/sun/tools/javac/messages.properties,
classpath/resource/sun/rmi/rmic/messages.properties,
classpath/tools/classes/com/sun/javadoc/ClassDoc.class,
classpath/tools/classes/com/sun/javadoc/ConstructorDoc.class,
classpath/tools/classes/com/sun/javadoc/Doc.class,
classpath/tools/classes/com/sun/javadoc/DocErrorReporter.class,
classpath/tools/classes/com/sun/javadoc/Doclet.class,
classpath/tools/classes/com/sun/javadoc/ExecutableMemberDoc.class,
classpath/tools/classes/com/sun/javadoc/FieldDoc.class,
classpath/tools/classes/com/sun/javadoc/MemberDoc.class,
classpath/tools/classes/com/sun/javadoc/MethodDoc.class,
classpath/tools/classes/com/sun/javadoc/PackageDoc.class,
classpath/tools/classes/com/sun/javadoc/ParamTag.class,
classpath/tools/classes/com/sun/javadoc/Parameter.class,
classpath/tools/classes/com/sun/javadoc/ProgramElementDoc.class,
classpath/tools/classes/com/sun/javadoc/RootDoc.class,
classpath/tools/classes/com/sun/javadoc/SeeTag.class,
classpath/tools/classes/com/sun/javadoc/SerialFieldTag.class,
classpath/tools/classes/com/sun/javadoc/SourcePosition.class,
classpath/tools/classes/com/sun/javadoc/Tag.class,
classpath/tools/classes/com/sun/javadoc/ThrowsTag.class,
classpath/tools/classes/com/sun/javadoc/Type.class,
classpath/tools/classes/com/sun/javadoc/TypeVariable.class,
classpath/tools/classes/com/sun/tools/doclets/Taglet.class,
classpath/tools/classes/sun/rmi/rmic/Main.class,
classpath/tools/classes/sun/rmi/rmic/Messages.class,
classpath/tools/com/sun/javadoc/ClassDoc.java,
classpath/tools/com/sun/javadoc/ConstructorDoc.java,
classpath/tools/com/sun/javadoc/Doc.java,
classpath/tools/com/sun/javadoc/DocErrorReporter.java,
classpath/tools/com/sun/javadoc/Doclet.java,
classpath/tools/com/sun/javadoc/ExecutableMemberDoc.java,
classpath/tools/com/sun/javadoc/FieldDoc.java,
classpath/tools/com/sun/javadoc/MemberDoc.java,
classpath/tools/com/sun/javadoc/MethodDoc.java,
classpath/tools/com/sun/javadoc/PackageDoc.java,
classpath/tools/com/sun/javadoc/ParamTag.java,
classpath/tools/com/sun/javadoc/Parameter.java,
classpath/tools/com/sun/javadoc/ProgramElementDoc.java,
classpath/tools/com/sun/javadoc/RootDoc.java,
classpath/tools/com/sun/javadoc/SeeTag.java,
classpath/tools/com/sun/javadoc/SerialFieldTag.java,
classpath/tools/com/sun/javadoc/SourcePosition.java,
classpath/tools/com/sun/javadoc/Tag.java,
classpath/tools/com/sun/javadoc/ThrowsTag.java,
classpath/tools/com/sun/javadoc/Type.java,
classpath/tools/com/sun/javadoc/TypeVariable.java,
classpath/tools/com/sun/tools/doclets/Taglet.java,
classpath/tools/com/sun/tools/javac/Main.java,
classpath/tools/com/sun/tools/javac/Messages.java,
classpath/tools/sun/rmi/rmic/Main.java,
classpath/tools/sun/rmi/rmic/Messages.java: New files.
* Makefile.in, classpath/Makefile.in, classpath/configure,
classpath/doc/Makefile.in, classpath/doc/api/Makefile.in,
classpath/examples/Makefile.in, classpath/external/Makefile.in,
classpath/external/jsr166/Makefile.in,
classpath/external/relaxngDatatype/Makefile.in,
classpath/external/sax/Makefile.in,
classpath/external/w3c_dom/Makefile.in,
classpath/include/Makefile.in, classpath/include/config.h.in,
classpath/lib/Makefile.in,
classpath/lib/gnu/classpath/Configuration.class,
classpath/native/Makefile.in, classpath/native/fdlibm/Makefile.in,
classpath/native/jawt/Makefile.in,
classpath/native/jni/Makefile.in,
classpath/native/jni/classpath/Makefile.in,
classpath/native/jni/gconf-peer/Makefile.in,
classpath/native/jni/gtk-peer/Makefile.in,
classpath/native/jni/java-io/Makefile.in,
classpath/native/jni/java-lang/Makefile.in,
classpath/native/jni/java-net/Makefile.in,
classpath/native/jni/java-nio/Makefile.in,
classpath/native/jni/java-util/Makefile.in,
classpath/native/jni/midi-alsa/Makefile.in,
classpath/native/jni/midi-dssi/Makefile.in,
classpath/native/jni/native-lib/Makefile.in,
classpath/native/jni/qt-peer/Makefile.in,
classpath/native/jni/xmlj/Makefile.in,
classpath/native/plugin/Makefile.in,
classpath/resource/Makefile.in, classpath/scripts/Makefile.in,
classpath/tools/Makefile.in, configure,
gnu/classpath/Configuration.h: Regenerate.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@122876 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libjava/classpath/tools/com/sun/javadoc/ClassDoc.java')
-rw-r--r-- | libjava/classpath/tools/com/sun/javadoc/ClassDoc.java | 322 |
1 files changed, 322 insertions, 0 deletions
diff --git a/libjava/classpath/tools/com/sun/javadoc/ClassDoc.java b/libjava/classpath/tools/com/sun/javadoc/ClassDoc.java new file mode 100644 index 00000000000..a4fa40a7cf7 --- /dev/null +++ b/libjava/classpath/tools/com/sun/javadoc/ClassDoc.java @@ -0,0 +1,322 @@ +/* ClassDoc.java -- Document a Java class or interface + Copyright (C) 1999 Free Software Foundation, Inc. + +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +02110-1301 USA. + +Linking this library statically or dynamically with other modules is +making a combined work based on this library. Thus, the terms and +conditions of the GNU General Public License cover the whole +combination. + +As a special exception, the copyright holders of this library give you +permission to link this library with independent modules to produce an +executable, regardless of the license terms of these independent +modules, and to copy and distribute the resulting executable under +terms of your choice, provided that you also meet, for each linked +independent module, the terms and conditions of the license of that +module. An independent module is a module which is not derived from +or based on this library. If you modify this library, you may extend +this exception to your version of the library, but you are not +obligated to do so. If you do not wish to do so, delete this +exception statement from your version. */ + + +package com.sun.javadoc; + +public interface ClassDoc extends ProgramElementDoc, Type +{ + +/** + * This method tests whether or not the class represented by this object + * is abstract. + * + * @return <code>true</code> if the class is abstract, <code>false</code>, + * otherwise. + */ +public abstract boolean +isAbstract(); + +/*************************************************************************/ + +/** + * This method tests whether or not the class represented by this object + * is serializable. That is, whether or not the class implements the + * <code>java.io.Serializable</code> interface. This includes classes + * which are externalizable. + * + * @return <code>true</code> if the class is serializable, + * <code>false</code> otherwise. + */ +public abstract boolean +isSerializable(); + +/*************************************************************************/ + +/** + * This method tests whether or not the class represented by this object + * is externalizable. That is, whether or not the class implements the + * <code>java.io.Externalizable</code> interface. + * + * @return <code>true</code> if the class is externalizable, + * <code>false</code> otherwise. + */ +public abstract boolean +isExternalizable(); + +/*************************************************************************/ + +/** + * This method returns the serialization methods for the class + * represented by this object. Is the custom readObject/writeObject + * methods? + * + * @return The serialization methods for this class. + */ +public abstract MethodDoc[] +serializationMethods(); + +/*************************************************************************/ + +/** + * This method returns the list of fields that are serialized in this + * class. This will return either the list of fields with an + * "@serial" declaration, or, if it exists, the + * <code>serialPersistentField</code> field. + * + * @return The list of serializable fields. + */ +public abstract FieldDoc[] +serializableFields(); + +/*************************************************************************/ + +/** + * This method tests whether or not the class represented by this object + * specifically defines its serializable fields in a + * <code>serialPersistentFields</code> field. + * + * @return <code>true</code> if this class explicitly defines its + * serializable fields, <code>false</code> otherwise. + */ +public abstract boolean +definesSerializableFields(); + +/*************************************************************************/ + +/** + * This method returns the superclass of the class represented by this + * object. + * + * @return The superclass of this class. + */ +public abstract ClassDoc +superclass(); + +/*************************************************************************/ + +/** + * This method tests whether or not the class represented by this object is + * a subclass of the specified class. + * + * @param cls The <code>ClassDoc</code> object of the class to test against. + * + * @return <code>true</code> if this class is a subclass of the specified + * class, <code>false</code> otherwise. + */ +public abstract boolean +subclassOf(ClassDoc cls); + +/*************************************************************************/ + +/** + * This method returns this list of interfaces implemented (or in the case + * of interfaces, extended) by this class. This list will only include + * interfaces directly implemented by this class, not those inherited by + * interfaced implemented in this class. + * + * @return The list of interfaces this class implements. + */ +public abstract ClassDoc[] +interfaces(); + +/*************************************************************************/ + +/** + * This method returns the list of fields that are visible to the user in + * this class, or the list of all fields in this class. + * + * @param filtered if true, only return visible (included) fields; + * otherwise, return all fields. + * + * @return The list of visible fields in this class, or the list of + * all fields in this class. + */ +public abstract FieldDoc[] +fields(boolean filtered); + +/*************************************************************************/ + +/** + * This method returns the list of fields that are visible to the user in + * this class. Does this depend on the -private -protected, etc flags + * passed to javadoc? + * + * @return The list of visible fields in this class. + */ +public abstract FieldDoc[] +fields(); + +/*************************************************************************/ + +/** + * This method returns either the list of methods that are visible to + * the user in the class represented by this object, or a list of all + * methods, excluding constructor methods. + * + * @param filtered if true, only return visible (included) methods; + * otherwise, return all methods. + * + * @return The list of all methods in this class, or the list of + * visible methods in this class. + */ +public abstract MethodDoc[] +methods(boolean filtered); + +/*************************************************************************/ + +/** + * This method returns the list of methods that are visible to the user in + * the class represented by this object, excluding constructor methods. + * + * @return The list of visible methods in this class. + */ +public abstract MethodDoc[] +methods(); + +/*************************************************************************/ + +/** + * This method returns either the list of constructors that are + * visible to the user in the class represented by this object, or + * the list of all constructors. + * + * @param filtered if true, only return visible (included) + * constructors; otherwise, return all constructors. + * + * @return The list of all constructors in this class, or the list + * of visible constructors in this class. + */ +public abstract ConstructorDoc[] +constructors(boolean filtered); + +/*************************************************************************/ + +/** + * This method returns the list of constructors that are visible to the user + * in the class represented by this object. + * + * @return The list visible constructors in this class. + */ +public abstract ConstructorDoc[] +constructors(); + +/*************************************************************************/ + +/** + * This method returns the list of inner classes that are visible to + * the user within the class represented by this object. + * + * @return The list of visible inner classes for this object. + */ +public abstract ClassDoc[] +innerClasses(); + +/*************************************************************************/ + +/** + * This method returns the list of all inner classes within the class + * represented by this object, or the list of visible inner classes + * in this class. + * + * @param filtered if true, only return visible (included) inner + * classes; otherwise, return all inner classes. + * + * @return The list of all inner classes for this object, or the list + * of visible inner classes. + */ +public abstract ClassDoc[] +innerClasses(boolean filtered); + +/*************************************************************************/ + +/** + * This method returns a <code>ClassDoc</code> for the named class. The + * following search order is used: + * <p> + * <ol> + * <li>Fully qualified class name. + * <li>Inner classes within this class. + * <li>In the current package. + * <li>In the imports for this class. + * </ol> + * + * @param name The name of the class to find. + * + * @return The requested class, or <code>null</code> if the requested + * class cannot be found. + */ +public abstract ClassDoc +findClass(String name); + +/*************************************************************************/ + +/** + * This method returns the list of classes that are imported. This + * excludes any imports of complete packages. + * + * @return The list of imported classes. + */ +public abstract ClassDoc[] +importedClasses(); + +/*************************************************************************/ + +/** + * This method returns the list of packages that are imported. This + * excludes any individual class imports. + * + * @return The list of imported packages. + */ +public abstract PackageDoc[] +importedPackages(); + +/*************************************************************************/ + +/** + * This method returns the formal type parameters of this class. + * The returned array is empty if the class does not represent a + * parameterized type. + * + * @return The list of type parameters. + * @since 1.5 + */ +TypeVariable[] +typeParameters(); + +} // interface ClassDoc + |