You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by sb...@apache.org on 2001/01/02 04:41:14 UTC
cvs commit: xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection Constructor.java EntryPoint.java Field.java Member.java Method.java
sboag 01/01/01 19:41:14
Modified: java/src/org/apache/xml/utils/synthetic Class.java
JavaUtils.java SynthesisException.java
java/src/org/apache/xml/utils/synthetic/reflection
Constructor.java EntryPoint.java Field.java
Member.java Method.java
Log:
Javadoc work. Removed many of the (broken) @see tags. Sorry,
but it would have taken way too much time to fix them, and I'm actually
not sure they were very useful. removed many empty @return tags.
Revision Changes Path
1.4 +94 -145 xml-xalan/java/src/org/apache/xml/utils/synthetic/Class.java
Index: Class.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/Class.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Class.java 2000/12/18 00:07:52 1.3
+++ Class.java 2001/01/02 03:41:13 1.4
@@ -63,7 +63,7 @@
import java.lang.reflect.Modifier;
-/* ***** WORK NEEDED:
+/* WORK NEEDED:
Factories/Libraries: We currently have forClass and
forName(request reified, complain if no real class),
and declareClass (request unreified, create unreified
@@ -77,6 +77,7 @@
*/
/**
+ * <meta name="usage" content="internal"/>
* org.apache.xml.utils.synthetic.Class is a mutable equivalent of java.lang.Class.
* Instances represent classes and interfaces in a running Java
* application, or class descriptions under construction. In the
@@ -108,8 +109,6 @@
* (Java source, NetRexx source, etc.)
*
* @since 2000/2/10
- * @see java.lang.class
- * @see defineClass
*/
public class Class extends Object implements java.io.Serializable
{
@@ -118,7 +117,8 @@
private static java.util.Hashtable global_classtable =
new java.util.Hashtable();
- /** fully-qualified path.classname */
+ /** fully-qualified path.classname.
+ * @serial */
private java.lang.String name;
/**
@@ -128,19 +128,19 @@
* a shared Interface), and allows "in-place compilation"
* to replace a generated description with an
* directly runnable class.
+ * @serial
*/
private java.lang.Class realclass = null;
/** Field modifiers: Java language modifiers for this class
* or interface, encoded in an integer.
- * @see getModifiers
- * @see setModifiers
+ * @serial
*/
private int modifiers;
/** Field isInterface: True if the Class object represents
* an interface type.
- * @see isInterface */
+ * @serial */
private boolean isInterface = false;
/** Field superclass: If this object represents the class
@@ -149,41 +149,33 @@
* is determined when needed. In synthesis mode it's explicitly
* set by the user, and if null the superclass will be assumed
* to be Object.
- * @see getSuperclass
- * @see setSuperclass */
+ * @serial */
private Class superclass = null;
/** Field declaringclass: If this object represents an inner class,
* the Class object that represents the class that declared it.
* Otherwise null.
- * @see addInnerClass
- * @see getDeclaringClass
+ * @serial
* */
private Class declaringclass = null;
/** Field interfaces: A list of all interfaces implemented by the class
* or interface represented by this object.
- * @see getInterfaces
- * @see declareInterface
- * @see getClasses
- * @see getDeclaredClasses
- * @see addExtends
+ * @serial
* */
private Class[] interfaces = new Class[0];
/** Field allclasses: an array containing Class objects representing all
* the public classes and interfaces that are members of the class
* represented by this Class object.
- * @see getClasses
- * @see addExtends
+ * @serial
*/
private Class[] allclasses = new Class[0];
/** Field declaredclasses: an array of Class objects reflecting all the
* classes and interfaces declared as members of the class represented
* by this Class object. Excludes inherited classes and interfaces.
- * @see getDeclaredClasses
- * @see addExtends
+ * @serial
*/
private Class[] declaredclasses = new Class[0];
@@ -193,8 +185,7 @@
* class has no public constructors. In proxy mode only public
* constructors will be displayed; in synthesis mode, all declared
* constructors will be displayed.
- * @see getConstructors
- * @see declareConstructor
+ * @serial
* */
private Constructor[] allconstructors = new Constructor[0];
@@ -202,24 +193,28 @@
* reflecting all the constructors declared by the class
* represented by this Class object. Includes non-public
* constructors, but excludes inherited ones.
- * @see getDeclaredConstructors
- * @see declareConstructor
+ * @serial
* */
private Constructor[] declaredconstructors = new Constructor[0];
- /** Field allmethods */
+ /** Field allmethods.
+ * @serial */
private Method[] allmethods = new Method[0];
- /** Field declaredmethods */
+ /** Field declaredmethods.
+ * @serial */
private Method[] declaredmethods = new Method[0];
- /** Field allfields */
+ /** Field allfields.
+ * @serial */
private Field[] allfields = new Field[0];
- /** Field declaredfields */
+ /** Field declaredfields.
+ * @serial */
private Field[] declaredfields = new Field[0];
- /** Field innerclasses */
+ /** Field innerclasses.
+ * @serial */
private Class[] innerclasses = new Class[0];
/**
@@ -253,9 +248,8 @@
* get the shared instances.
* <p>
* Creation date: (12-25-99 12:15:23 PM)
- * @param name java.lang.String
*
- * @param fullname
+ * @param fullname full name of the class that is synthetized.
*/
Class(String fullname)
{
@@ -307,9 +301,9 @@
* inner clases. As with forName, if this can not be resolved
* we throw an exception.
*
- * @param classname
+ * @param classname the full or partial class name.
*
- * @return
+ * @return The Class name that matches the argument.
*
* @throws ClassNotFoundException
*/
@@ -471,8 +465,7 @@
*
* @param className the fully qualified name of the desired class.
* @return the synthetic Class descriptor for the class with the specified name.
- * @throws SynthesisException
- * if the class has been reified.
+ * @throws SynthesisException if the class has been reified.
*/
public static Class declareClass(String className) throws SynthesisException
{
@@ -538,7 +531,7 @@
* marginally useful, which is no doubt one of the reasons folks
* have declined to implement it.
*
- * @return
+ * @return an array of classes.
*/
public Class[] getClasses()
{
@@ -561,12 +554,9 @@
/**
* Determines the class loader for the class.
*
- * @return
* the class loader that created the class or
* interface represented by this object, or null
* if the org.apache.xml.utils.synthetic.Class was not created by a class loader.
- * @see
- * ClassLoader
*/
public ClassLoader getClassLoader()
{
@@ -581,10 +571,9 @@
* NOTE: Since org.apache.xml.utils.synthetic.Class doesn't yet attempt to model array
* types, this will currently return false unless we are
* proxying such a type.
- *
- * @see Array
*
- * @return
+ * @return the Class object representing the component type of
+ * the array, otherwise returns null.
*/
public Class getComponentType()
{
@@ -605,15 +594,18 @@
* exactly the same formal parameter types.
*
*
- * @param parameterTypes
+ * @param parameterTypes array of Class
+ * objects that identify the constructor's formal
+ * parameter types, in declared order.
*
- * @return
+ * @return a Constructor object that reflects the
+ * specified public constructor of the class
+ * represented by this Class object.
+ *
* @throws NoSuchMethodException
* if a matching method is not found.
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Constructor
* @throws SynthesisException
*/
public Constructor getConstructor(Class parameterTypes[])
@@ -642,11 +634,12 @@
* constructors.
*
*
- * @return
+ * @return an array containing Constructor objects
+ * reflecting all the public constructors of the class
+ * represented by this Class object.
+ *
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Constructor
*/
public Constructor[] getConstructors() throws SecurityException
{
@@ -680,7 +673,10 @@
* this Class object represents a primitive type.
*
*
- * @return
+ * @return an array of Class objects reflecting all the
+ * classes and interfaces declared as members of the
+ * class represented by this Class object.
+ *
* @throws SecurityException
* if access to the information is denied.
*/
@@ -710,12 +706,9 @@
* Adds an "extends" description for the class or
* interface represented by this Class object
*
- *
- * @param newclass
+ * @param newclass The class that this class extends.
* @throws SynthesisException
* if the class has been reified.
- * @see
- * class
*/
public void addExtends(Class newclass) throws SynthesisException
{
@@ -740,15 +733,18 @@
* parameter types, in declared order.
*
*
- * @param parameterTypes
+ * @param parameterTypes array of Class
+ * objects that identify the constructor's formal
+ * parameter types, in declared order.
*
- * @return
+ * @return a Constructor object that reflects the
+ * specified declared constructor of the class or
+ * interface represented by this Class object.
+ *
* @throws NoSuchMethodException
* if a matching method is not found.
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Constructor
*/
public Constructor getDeclaredConstructor(Class parameterTypes[])
throws NoSuchMethodException, SecurityException
@@ -760,12 +756,10 @@
* Adds a Constructor description for the class or
* interface represented by this Class object
*
- *
- * @return
+ * @return The constructor object.
+ *
* @throws SynthesisException
* if the class has been reified.
- * @see
- * Constructor
*/
public Constructor declareConstructor() throws SynthesisException
{
@@ -797,15 +791,10 @@
* attempt to inherit data.
*
* @param newifce org.apache.xml.utils.synthetic.Class representing the interface we want to add.
- *
- * @return
- * @exception org.apache.xml.utils.synthetic.SynthesisException if the Class isn't an interface
- * @see setSuperClass
- * @see declareConstructor
- * @see declareMethod
- * @see declareField
*
- * @throws SynthesisException
+ * @return The new interface class.
+ *
+ * @throws org.apache.xml.utils.synthetic.SynthesisException if the Class isn't an interface
*/
public Class declareInterface(Class newifce) throws SynthesisException
{
@@ -845,11 +834,12 @@
* See The Java Language Specification, section 8.2.
*
*
- * @return
+ * @return an array of Constructor objects reflecting
+ * all the constructors declared by the class
+ * represented by this Class object.
+ *
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Constructor
*/
public Constructor[] getDeclaredConstructors() throws SecurityException
{
@@ -878,15 +868,17 @@
* field.
*
*
- * @param name
+ * @param name String that specifies the simple name of the desired
+ * field.
*
- * @return
+ * @return a Field object that reflects the specified
+ * declared field of the class or interface represented
+ * by this Class object.
+ *
* @throws NoSuchFieldException
* if a field with the specified name is not found.
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Field
*/
public Field getDeclaredField(String name)
throws NoSuchFieldException, SecurityException
@@ -899,13 +891,12 @@
* interface represented by this Class object
*
*
- * @param name
+ * @param name The name of the field.
*
- * @return
+ * @return The field description.
+ *
* @throws SynthesisException
* if the class has been reified.
- * @see
- * Constructor
*/
public Field declareField(String name) throws SynthesisException
{
@@ -942,11 +933,12 @@
* Specification, sections 8.2 and 8.3.
*
*
- * @return
+ * @return array of Field objects reflecting all the
+ * fields declared by the class or interface represented
+ * by this Class object.
+ *
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Field
*/
public Field[] getDeclaredFields() throws SecurityException
{
@@ -977,16 +969,21 @@
* types, in declared order.
*
*
- * @param name
- * @param parameterTypes
+ * @param name String that specifies the simple
+ * name of the desired method.
+ *
+ * @param parameterTypes array of Class
+ * objects that identify the method's formal parameter
+ * types, in declared order.
*
- * @return
+ * @return Method object that reflects the specified
+ * declared method of the class or interface
+ * represented by this Class object.
+ *
* @throws NoSuchMethodException
* if a matching method is not found.
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Method
*/
public Method getDeclaredMethod(String name, Class parameterTypes[])
throws NoSuchMethodException, SecurityException
@@ -999,13 +996,12 @@
* interface represented by this Class object
*
*
- * @param name
+ * @param name Name of method.
*
- * @return
+ * @return The method object.
+ *
* @throws SynthesisException
* if the class has been reified.
- * @see
- * Constructor
*/
public Method declareMethod(String name) throws SynthesisException
{
@@ -1041,13 +1037,13 @@
* represents a primitive type.
* <p>
* See The Java Language Specification, section 8.2.
- *
*
- * @return
+ * @return array of Method objects reflecting all
+ * the methods declared by the class or interface
+ * represented by this Class object.
+ *
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Method
*/
public Method[] getDeclaredMethods() throws SecurityException
{
@@ -1077,7 +1073,6 @@
* class or interface is not a member of any other
* class.
*
- * @return
*/
public Class getDeclaringClass()
{
@@ -1132,9 +1127,8 @@
* hierarchy is established by the class within which it is
* created.
* @return org.apache.xml.utils.synthetic.Class object for the contained class.
- * @exception org.apache.xml.utils.synthetic.SynthesisException if class could not be created.
+ * @throws org.apache.xml.utils.synthetic.SynthesisException if class could not be created.
* @since 2/2000
- * @see forName
*
* @throws SynthesisException
*/
@@ -1173,7 +1167,6 @@
* This may be empty if none such exist, or if the class is
* reified (since reflection doesn't report this information).
* @since 3/2000
- * @see forName
*/
public Class[] getInnerClasses()
{
@@ -1198,14 +1191,11 @@
*
* @param name
*
- * @return
* @throws NoSuchFieldException
* if a field with the specified name is not
* found.
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Field
*/
public Field getField(String name)
throws NoSuchFieldException, SecurityException
@@ -1237,10 +1227,8 @@
* and 8.3.
*
*
- * @return
* @throws SecurityException
* if access to the information is denied.
- * @see Field
*/
public Field[] getFields() throws SecurityException
{
@@ -1283,7 +1271,6 @@
* If the class or interface implements no interfaces,
* the method returns an array of length 0.
*
- * @return
* an array of interfaces implemented by this
* class.
*/
@@ -1313,8 +1300,6 @@
* @param newclass
* @throws SynthesisException
* if the class has been reified.
- * @see
- * class
*/
public void addImplements(Class newclass) throws SynthesisException
{
@@ -1353,13 +1338,10 @@
* @param name
* @param parameterTypes
*
- * @return
* @throws NoSuchMethodException
* if a matching method is not found.
* @throws SecurityException
* if access to the information is denied.
- * @see
- * Method
*/
public Method getMethod(String name, Class parameterTypes[])
throws NoSuchMethodException, SecurityException
@@ -1380,10 +1362,8 @@
* and 8.4.
*
*
- * @return
* @throws SecurityException
* if access to the information is denied.
- * @see Method
*/
public Method[] getMethods() throws SecurityException
{
@@ -1417,7 +1397,6 @@
* See Also:
* java.lang.reflect.Modifier
*
- * @return
*/
public int getModifiers()
{
@@ -1457,9 +1436,6 @@
*
* @return java.lang.String
* @since 12/95
- * @see getShortName
- * @see getJavaName
- * @see getJavaShortName
*/
public java.lang.String getName()
{
@@ -1472,8 +1448,6 @@
*
* @return java.lang.String
* @since 3/2000
- * @see getName
- * @see getJavaShortName
*/
public java.lang.String getJavaName()
{
@@ -1505,10 +1479,6 @@
*
* @return java.lang.String
* @since 12/99
- * @see getName
- * @see getPackageName
- * @see getJavaName
- * @see getJavaShortName
*/
public java.lang.String getShortName()
{
@@ -1535,8 +1505,6 @@
*
* @return java.lang.String
* @since 3/2000
- * @see getJavaName
- * @see getShortName
*/
public java.lang.String getJavaShortName()
{
@@ -1568,10 +1536,6 @@
*
* @return java.lang.String
* @since 12/95
- * @see getName
- * @see getShortName
- * @see getJavaName
- * @see getJavaShortName
*/
public java.lang.String getPackageName()
{
@@ -1698,12 +1662,9 @@
* @param
* name - the string representing the resource to
* be found.
- * @return
* the URL object having the specified name, or
* null if no resource with the specified name
* is found.
- * @see ClassLoader
- * @see getResourceAsStream
*/
public java.net.URL getResource(String name)
{
@@ -1726,12 +1687,9 @@
* @param
* name - the string representing the resource to
* be found
- * @return
* the InputStream object having the
* specified name, or null if no resource with
* the specified name is found.
- * @see ClassLoader
- * @see getResource
*/
public java.io.InputStream getResourceAsStream(String name)
{
@@ -1741,7 +1699,6 @@
/**
* Get the signers of this class.
*
- * @return
*/
public Object[] getSigners()
{
@@ -1757,7 +1714,6 @@
* Object or this object represents an interface, null is
* returned.
*
- * @return
* the superclass of the class represented by this
* object.
*/
@@ -1781,7 +1737,6 @@
* If this Class object represents an array type, returns
* true, otherwise returns false.
*
- * @return
*/
public boolean isArray()
{
@@ -1808,7 +1763,6 @@
*
* @param cls
*
- * @return
* @throws NullPointerException if the specified Class parameter is null.
*/
public boolean isAssignableFrom(Class cls)
@@ -1840,7 +1794,6 @@
*
* @param cls
*
- * @return
* @throws NullPointerException if the specified Class parameter is null.
*/
public boolean isAssignableFrom(java.lang.Class cls)
@@ -1876,7 +1829,6 @@
*
* @param obj The object to check
*
- * @return
*/
public boolean isInstance(Object obj)
{
@@ -1893,7 +1845,6 @@
* Determines if the specified Class object represents
* an interface type.
*
- * @return
* true if this object represents an interface;
* false otherwise.
*/
@@ -1939,7 +1890,6 @@
* only Class objects for which this method returns
* true.
*
- * @return
*/
public boolean isPrimitive()
{
@@ -1949,7 +1899,6 @@
/**
* Creates a new instance of a class.
*
- * @return
* a newly allocated instance of the class
* represented by this object. This is done
* exactly as if by a new expression with an
1.2 +4 -2 xml-xalan/java/src/org/apache/xml/utils/synthetic/JavaUtils.java
Index: JavaUtils.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/JavaUtils.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- JavaUtils.java 2000/11/23 04:58:52 1.1
+++ JavaUtils.java 2001/01/02 03:41:13 1.2
@@ -54,14 +54,16 @@
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
- * $Id: JavaUtils.java,v 1.1 2000/11/23 04:58:52 sboag Exp $
+ * $Id: JavaUtils.java,v 1.2 2001/01/02 03:41:13 sboag Exp $
*/
package org.apache.xml.utils.synthetic;
import java.io.IOException;
-/** This class supports invoking Java compilation from within
+/**
+ * <meta name="usage" content="internal"/>
+ * This class supports invoking Java compilation from within
* a Java program. Recent versions of the Java environment have
* provided such an API (in tools.jar). But that isn't available
* on all platforms, and a fallback to the command line may be needed
1.3 +2 -2 xml-xalan/java/src/org/apache/xml/utils/synthetic/SynthesisException.java
Index: SynthesisException.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/SynthesisException.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SynthesisException.java 2000/12/18 00:07:52 1.2
+++ SynthesisException.java 2001/01/02 03:41:13 1.3
@@ -63,7 +63,8 @@
public class SynthesisException extends Exception
{
- /** Field code */
+ /** Field code.
+ * @serial */
int code;
// Manefest constants
@@ -124,7 +125,6 @@
* Method getCode
*
*
- * @return
*/
int getCode()
{
1.3 +1 -5 xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Constructor.java
Index: Constructor.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Constructor.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Constructor.java 2000/12/18 00:07:53 1.2
+++ Constructor.java 2001/01/02 03:41:13 1.3
@@ -61,6 +61,7 @@
import org.apache.xml.utils.synthetic.SynthesisException;
/**
+ * <meta name="usage" content="internal"/>
* Constructor provides information about, and access to, a
* single constructor for a class.
*
@@ -70,11 +71,6 @@
* throws an IllegalArgumentException if a narrowing
* conversion would occur.
*
- * @see Member
- * @see Class
- * @see getConstructors
- * @see getConstructor
- * @see getDeclaredConstructors
*/
public class Constructor extends EntryPoint implements Member
{
1.3 +3 -16 xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/EntryPoint.java
Index: EntryPoint.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/EntryPoint.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- EntryPoint.java 2000/12/18 00:07:53 1.2
+++ EntryPoint.java 2001/01/02 03:41:13 1.3
@@ -60,14 +60,15 @@
import org.apache.xml.utils.synthetic.SynthesisException;
-/**
- * *** OPEN ISSUES:
+/*
+ * OPEN ISSUES:
* Reflection doesn't tell us about deprecation; if we want
* that info, MFC advises mousing our way into the class (ugh).
* Should we at least model that for synthetics?
*/
/**
+ * <meta name="usage" content="internal"/>
* API/behaviors shared between Constructors and Methods.
* They're mostly similar, except for what they proxy and
* a few specific calls (name, invoke/getInstance).
@@ -203,7 +204,6 @@
*
* @param obj
*
- * @return
*/
public boolean equals(Object obj)
{
@@ -227,7 +227,6 @@
* declares the constructor represented by this
* Constructor object.
*
- * @return
*/
public org.apache.xml.utils.synthetic.Class getDeclaringClass()
{
@@ -239,7 +238,6 @@
* will be returned by this EntryPoint. Needed by the Method
* API, but made meaningful for Constructors as well.
*
- * @return
*/
public org.apache.xml.utils.synthetic.Class getReturnType()
{
@@ -253,7 +251,6 @@
* Constructor object. Returns an array of length 0 if
* the constructor throws no checked exceptions.
*
- * @return
*/
public org.apache.xml.utils.synthetic.Class[] getExceptionTypes()
{
@@ -306,10 +303,6 @@
* as an integer. The Modifier class should be used to
* decode the modifiers.
*
- * @see
- * Modifier
- *
- * @return
*/
public int getModifiers()
{
@@ -357,7 +350,6 @@
* Returns an array of length 0 if the underlying
* constructor takes no parameters.
*
- * @return
*/
public org.apache.xml.utils.synthetic.Class[] getParameterTypes()
{
@@ -430,7 +422,6 @@
* xor'ed (for Methods) with the method name.
* (Implemented in the subclasses rather than here.)
*
- * @return
*/
abstract public int hashCode();
@@ -489,7 +480,6 @@
* <p>
* Methods will also display their checked exceptions.
*
- * @return
*/
public String toString()
{
@@ -562,7 +552,6 @@
* method body. Note that this returns a mutable object,
* for editing etc. Slightly sloppy first cut.
*
- * @return
*/
public StringBuffer getBody()
{
@@ -577,7 +566,6 @@
* Extension: For synthesis, we need a place to hang a
* method body.
*
- * @return
*/
public String getLanguage()
{
@@ -589,7 +577,6 @@
*
* @param basetab
*
- * @return
*/
public String toSource(String basetab)
{
1.3 +1 -57 xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Field.java
Index: Field.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Field.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Field.java 2000/12/18 00:07:53 1.2
+++ Field.java 2001/01/02 03:41:13 1.3
@@ -60,6 +60,7 @@
import org.apache.xml.utils.synthetic.SynthesisException;
/**
+ * <meta name="usage" content="internal"/>
* A Field provides information about, and dynamic access
* to, a single field of a class or an interface. The reflected
* field may be a class (static) field or an instance field.
@@ -69,12 +70,6 @@
* IllegalArgumentException if a narrowing conversion
* would occur.
*
- * @see Member
- * @see Class
- * @see getFields
- * @see getField
- * @see getDeclaredFields
- * @see getDeclaredField
*/
public class Field extends Object implements Member
{
@@ -129,7 +124,6 @@
*
* @param obj
*
- * @return
*/
public boolean equals(Object obj)
{
@@ -178,7 +172,6 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
@@ -205,14 +198,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public boolean getBoolean(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -231,14 +221,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public byte getByte(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -257,14 +244,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public char getChar(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -281,7 +265,6 @@
* interface that declares the field represented by this
* Field object.
*
- * @return
*/
public org.apache.xml.utils.synthetic.Class getDeclaringClass()
{
@@ -300,14 +283,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public double getDouble(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -326,14 +306,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public float getFloat(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -351,14 +328,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public int getInt(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -377,14 +351,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public long getLong(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -402,10 +373,6 @@
* Modifier class should be used to decode the
* modifiers.
*
- * @see
- * Modifier
- *
- * @return
*/
public int getModifiers()
{
@@ -461,14 +428,11 @@
*
* @param obj
*
- * @return
* @throws IllegalAccessException
* if the underlying constructor is inaccessible.
* @throws IllegalArgumentException
* if the field value cannot be converted to the
* return type by a widening conversion.
- * @see
- * get
*/
public short getShort(Object obj)
throws IllegalArgumentException, IllegalAccessException
@@ -484,7 +448,6 @@
* Returns a Class object that identifies the declared
* type for the field represented by this Field object.
*
- * @return
*/
public Class getType()
{
@@ -519,7 +482,6 @@
* the underlying field's declaring class name and its
* name.
*
- * @return
*/
public int hashCode()
{
@@ -606,8 +568,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setBoolean(Object obj, boolean z)
throws IllegalArgumentException, IllegalAccessException
@@ -633,8 +593,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setByte(Object obj, byte b)
throws IllegalArgumentException, IllegalAccessException
@@ -660,8 +618,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setChar(Object obj, char c)
throws IllegalArgumentException, IllegalAccessException
@@ -700,8 +656,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setDouble(Object obj, double d)
throws IllegalArgumentException, IllegalAccessException
@@ -727,8 +681,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setFloat(Object obj, float f)
throws IllegalArgumentException, IllegalAccessException
@@ -754,8 +706,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setInt(Object obj, int i)
throws IllegalArgumentException, IllegalAccessException
@@ -781,8 +731,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setLong(Object obj, long l)
throws IllegalArgumentException, IllegalAccessException
@@ -825,8 +773,6 @@
* the class or interface declaring the
* underlying field, or if an unwrapping
* conversion fails.
- * @see
- * set
*/
public void setShort(Object obj, short s)
throws IllegalArgumentException, IllegalAccessException
@@ -856,7 +802,6 @@
* and then other modifiers in the following order:
* static, final, transient, volatile.
*
- * @return
*/
public String toString()
{
@@ -870,7 +815,6 @@
/**
* Output the Field as Java sourcecode
*
- * @return
*/
public String toSource()
{
1.3 +1 -10 xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Member.java
Index: Member.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Member.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Member.java 2000/12/18 00:07:53 1.2
+++ Member.java 2001/01/02 03:41:13 1.3
@@ -59,6 +59,7 @@
import org.apache.xml.utils.synthetic.SynthesisException;
/**
+ * <meta name="usage" content="internal"/>
* Member is an interface that reflects identifying
* information about a single member (a field or a method)
* or a constructor.
@@ -67,11 +68,7 @@
* java.lang.reflect.Member, due to questions about how to handle
* declarignClass.
*
- * @see Field
- * @see Method
- * @see Constructor
* @see org.apache.xml.utils.synthetic.Class
- * @see java.lang.reflect.Member
*/
public interface Member
{
@@ -81,7 +78,6 @@
* interface that declares the member or constructor
* represented by this Member.
*
- * @return
*/
public abstract org.apache.xml.utils.synthetic.Class getDeclaringClass();
@@ -91,9 +87,6 @@
* Member, as an integer. The Modifier class should
* be used to decode the modifiers in the integer.
*
- * @see Modifier
- *
- * @return
*/
public abstract int getModifiers();
@@ -115,8 +108,6 @@
* member or constructor represented by this
* Member, as an integer. The Modifier class should
* be used to decode the modifiers in the integer.
- *
- * @see Modifier
*
* @param modifiers
*
1.3 +1 -8 xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Method.java
Index: Method.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/synthetic/reflection/Method.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Method.java 2000/12/18 00:07:53 1.2
+++ Method.java 2001/01/02 03:41:13 1.3
@@ -61,6 +61,7 @@
import org.apache.xml.utils.synthetic.SynthesisException;
/**
+ * <meta name="usage" content="internal"/>
* A Method provides information about, and access to, a
* single method on a class or interface. The reflected
* method may be a class method or an instance method
@@ -76,12 +77,6 @@
* That may or may not imply retaining the final return value
* separately and passing in a how-to-use-it mechanism...?
*
- * @see Member
- * @see Class
- * @see getMethods
- * @see getMethod
- * @see getDeclaredMethods
- * @see getDeclaredMethod
*/
public class Method extends EntryPoint implements Member
{
@@ -138,7 +133,6 @@
* for the underlying method's declaring class name
* and the method's name.
*
- * @return
*/
/**
@@ -238,7 +232,6 @@
* @param obj
* @param args
*
- * @return
*
* @throws IllegalAccessException
* @throws IllegalArgumentException