- Revision
- 1291
- Author
- rfscholte
- Date
- 2011-08-11 15:07:39 -0500 (Thu, 11 Aug 2011)
Log Message
improve javadoc
Modified Paths
Diff
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java (1290 => 1291)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java 2011-08-10 20:15:51 UTC (rev 1290) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java 2011-08-11 20:07:39 UTC (rev 1291) @@ -93,6 +93,10 @@ JavaSource getParentSource(); + /** + * Equivalent of {@link java.lang.Class#getPackage()} + * @return + */ JavaPackage getPackage(); JavaClassParent getParent(); @@ -125,6 +129,7 @@ * </ul> * * @return the resolved name, otherwise <code>null</code>. + * @deprecated use {@link #resolveCanonicalName(String)} or {@link #resolveFullyQualifiedName(String)} instead */ String resolveType( String name ); @@ -154,12 +159,22 @@ */ String getClassNamePrefix(); - @Deprecated + /** + * + * + * @deprecated the JavaClass should have the same methods + */ Type asType(); + /** + * Equivalent of {@link java.lang.Class#getMethods()} + * + * @return the methods declared or overridden in this class + */ List<JavaMethod> getMethods(); /** + * Equivalent of {@link java.lang.Class#getConstructors()} * * @return the list of constructors * @since 2.0 @@ -247,8 +262,19 @@ List<JavaMethod> getMethodsBySignature( String name, List<Type> parameterTypes, boolean superclasses, boolean varArg ); + /** + * Equivalent of {@link java.lang.Class#getFields()} + * + * @return a list of fiels, never <code>null</code> + */ List<JavaField> getFields(); + /** + * Equivalent of {@link java.lang.Class#getField(String)}, where this method can resolve every field + * + * @param name + * @return + */ JavaField getFieldByName( String name ); /** @@ -269,7 +295,7 @@ /** * @since 1.3 */ - boolean isA( String fullClassName ); + boolean isA( String fullyQualifiedName ); /** * @param javaClass @@ -279,10 +305,16 @@ /** * - * @return + * @return the number of dimensions, at least 0 + * @since 2.0 */ int getDimensions(); + /** + * + * @return <code>true</code> if this JavaClass is an array, otherwise <code>false</code> + * @since 2.0 + */ boolean isArray(); /** @@ -441,6 +473,11 @@ */ boolean isAbstract(); + /** + * Equivalent of {@link java.lang.Class#isPrimitive()} + * + * @return <code>true</code> if this class represents a primitive, otherwise <code>false</code> + */ boolean isPrimitive(); /**
To unsubscribe from this list please visit:
