- Revision
- 1271
- Author
- rfscholte
- Date
- 2011-07-24 07:37:17 -0500 (Sun, 24 Jul 2011)
Log Message
completing javadoc, reducing its number of warnings
Modified Paths
- trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/library/AbstractClassLibrary.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/library/JavaClassContext.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/library/OrderedClassLibraryBuilder.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java
Diff
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java (1270 => 1271)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java 2011-07-21 20:53:40 UTC (rev 1270) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java 2011-07-24 12:37:17 UTC (rev 1271) @@ -44,32 +44,35 @@ /** * This is the improved version of the JavaDocBuilder of QDox 1.x, which has the following tasks: * <ul> - * <li>Provide adders for all kind of resources, such as classloaders, java files and source directories</li> - * <li>Provide setters to enable the debug-mode for the Lexer and Parser (which are used when parsing sourcefiles) and the encoding - * <li>Provide getter for retrieving Java Object Models from these libraries, such as JavaSources, JavaClasses and JavaPackages</li> - * <li>Provide a method to search through all the parsed JavaClasses </li> - * <li>Provide store and load methods for the JavaProjectBuilder</li> + * <li>Provide adders for all kind of resources, such as classloaders, java files and source directories</li> + * <li>Provide setters to enable the debug-mode for the Lexer and Parser (which are used when parsing sourcefiles) and + * the encoding + * <li>Provide getter for retrieving Java Object Models from these libraries, such as JavaSources, JavaClasses and + * JavaPackages</li> + * <li>Provide a method to search through all the parsed JavaClasses</li> + * <li>Provide store and load methods for the JavaProjectBuilder</li> + * <li>Provide the option to set an ErrorHandler</li> * </ul> + * By default the JavaProjectBuilder will use the {@link SortedClassLibraryBuilder}, which means it doesn't matter in + * which order you add the resources, first all sources and sourcefolders, followed by the classloaders. Another + * implementation for the ClassLibraryBuilder is the {@link OrderedClassLibraryBuilder}, which preserves the order in + * which resources are added. By creating a new JavaProjectBuilder with your own ClassLibraryBuilder you can decide + * which loading strategy should be used. * - * By default the JavaProjectBuilder will use the {@link} SortedClassLibraryBuilder}, which means it doesn't matter in which order you add the resources, - * first all sources and sourcefolders, followed by the classloaders. Another implementation for the ClassLibraryBuilder is the - * {@link OrderedClassLibraryBuilder}, which preserves the order in which resources are added. - * By creating a new JavaProjectBuilder with your own ClassLibraryBuilder you can decide which loading strategy should be used. - * * @author Robert Scholte * @since 2.0 */ public class JavaProjectBuilder { private final ClassLibraryBuilder classLibraryBuilder; - + // Constructors - + /** * Default constructor, which will use the {@link SortedClassLibraryBuilder} implementation */ public JavaProjectBuilder() - { + { this.classLibraryBuilder = new SortedClassLibraryBuilder(); } @@ -78,18 +81,18 @@ * * @param classLibraryBuilder custom implementation of {@link ClassLibraryBuilder} */ - public JavaProjectBuilder(ClassLibraryBuilder classLibraryBuilder) - { + public JavaProjectBuilder( ClassLibraryBuilder classLibraryBuilder ) + { this.classLibraryBuilder = classLibraryBuilder; } // Lexer and Parser -setters - + /** * Enable the debugmode for the Lexer * * @param debugLexer <code>true</code> to enable, <code>false</code> to disable - * @return This javaProjectBuilder itself + * @return this javaProjectBuilder itself */ public JavaProjectBuilder setDebugLexer( boolean debugLexer ) { @@ -101,7 +104,7 @@ * Enable the debugmode for the Parser * * @param debugParser <code>true</code> to enable, <code>false</code> to disable - * @return This javaProjectBuilder itself + * @return this javaProjectBuilder itself */ public JavaProjectBuilder setDebugParser( boolean debugParser ) { @@ -112,7 +115,7 @@ /** * Sets the encoding when using Files or URL's to parse. * - * @param encoding the encoding to use for {@link File} or ({@link URL} + * @param encoding the encoding to use for {@link File} or {@link URL} * @return this javaProjectBuilder itself */ public JavaProjectBuilder setEncoding( String encoding ) @@ -120,14 +123,15 @@ classLibraryBuilder.setEncoding( encoding ); return this; } - + /** * Sets the errorHandler which will be triggered when a parse exception occurs. * * @param errorHandler the errorHandler * @return this javaProjectBuilder itself */ - public JavaProjectBuilder setErrorHandler( ErrorHandler errorHandler) { + public JavaProjectBuilder setErrorHandler( ErrorHandler errorHandler ) + { classLibraryBuilder.setErrorHander( errorHandler ); return this; } @@ -136,27 +140,28 @@ * Add a java file to this JavaProjectBuilder * * @param file a java file - * @return the {@link JavaSource} of the parsed file - * @throws IOException + * @return the {@link JavaSource} of the parsed file + * @throws IOException if file is a directory or can't be read */ - public JavaSource addSource(File file) throws IOException + public JavaSource addSource( File file ) + throws IOException { return classLibraryBuilder.addSource( file ); } - + // Resource adders - - public JavaSource addSource( Reader reader ) + + public JavaSource addSource( Reader reader ) { return classLibraryBuilder.addSource( reader ); } /** - * Add a sourcefolder to this javaprojectbuilder, but don't parse any file. - * This is a lazy parser. - * Only if a JavaClass is called it will be searched by matching the package with the folder structure and the classname with the filename + * Add a sourcefolder to this javaprojectbuilder, but don't parse any file. This is a lazy parser. Only if a + * JavaClass is called it will be searched by matching the package with the folder structure and the classname with + * the filename * - * @see {@link #addSourceTree(File)} + * @see #addSourceTree(File) * @param sourceFolder the sourcefolder to add */ public void addSourceFolder( File sourceFolder ) @@ -164,47 +169,53 @@ classLibraryBuilder.appendSourceFolder( sourceFolder ); } - /** - * Add all java files of the {@value directory} recursively + * Add all java files of the {@code directory} recursively * * @param directory the directory from which all java files should be parsed. */ public void addSourceTree( File directory ) { - FileVisitor visitor = new FileVisitor() { - public void visitFile(File badFile) { - throw new RuntimeException("Cannot read file : " + badFile.getName()); + FileVisitor visitor = new FileVisitor() + { + public void visitFile( File badFile ) + { + throw new RuntimeException( "Cannot read file : " + badFile.getName() ); } }; - addSourceTree(directory, visitor); + addSourceTree( directory, visitor ); } /** - * Add all java files of the {@value directory} recursively + * Add all java files of the {@code directory} recursively * * @param directory the directory from which all java files should be parsed. * @param errorHandler a fileVisitor which will be triggered when an {@link IOException} occurs. */ public void addSourceTree( File directory, final FileVisitor errorHandler ) { - DirectoryScanner scanner = new DirectoryScanner(directory); - scanner.addFilter(new SuffixFilter(".java")); - scanner.scan(new FileVisitor() { - public void visitFile(File currentFile) { - try { - addSource(currentFile); - } catch (IOException e) { - errorHandler.visitFile(currentFile); + DirectoryScanner scanner = new DirectoryScanner( directory ); + scanner.addFilter( new SuffixFilter( ".java" ) ); + scanner.scan( new FileVisitor() + { + public void visitFile( File currentFile ) + { + try + { + addSource( currentFile ); } + catch ( IOException e ) + { + errorHandler.visitFile( currentFile ); + } } - }); + } ); } - + /** - * Add the classLoader to this JavaProjectBuilder + * Add the {@link ClassLoader} to this JavaProjectBuilder * - * @param classLoader + * @param classLoader the classloader to add */ public void addClassLoader( ClassLoader classLoader ) { @@ -214,27 +225,27 @@ // Java Object Model -getters /** - * Try to retrieve a JavaClass by its name. + * Try to retrieve a {@link JavaClass} by its name. * * @param name the fully qualified name of the class - * @return the matching {@link JavaClass}, otherwise <code>null</code> + * @return the matching JavaClass, otherwise <code>null</code> */ public JavaClass getClassByName( String name ) { return classLibraryBuilder.getClassLibrary().getJavaClass( name ); } - + /** - * Get all the sources added. - * This will only contain the sources added as sourcefile, sourcetree or sourcefolder. + * Get all the sources added. This will only contain the sources added as sourcefile, sourcetree or sourcefolder. * * @return a list of sources - * @see {@link #addSource(File)} - * @see {@link #addSource(Reader)} - * @see {@link #addSourceFolder(File)} - * @see {@link #addSourceTree(File)} + * @see #addSource(File) + * @see #addSource(Reader) + * @see #addSourceFolder(File) + * @see #addSourceTree(File) */ - public List<JavaSource> getSources() { + public List<JavaSource> getSources() + { return classLibraryBuilder.getClassLibrary().getJavaSources(); } @@ -242,10 +253,10 @@ * Retrieve all classes which were added by sources * * @return a list of javaclasses, never <code>null</code> - * @see {@link #addSource(File)} - * @see {@link #addSource(Reader)} - * @see {@link #addSourceFolder(File)} - * @see {@link #addSourceTree(File)} + * @see #addSource(File) + * @see #addSource(Reader) + * @see #addSourceFolder(File) + * @see #addSourceTree(File) */ public List<JavaClass> getClasses() { @@ -253,9 +264,10 @@ } /** + * Try to retrieve a {@link JavaPackage} by its name. * - * @param name - * @return + * @param name the package name + * @return the matching JavaPackage, otherwise <code>null</code> */ public JavaPackage getPackageByName( String name ) { @@ -266,10 +278,10 @@ * Retrieve all packages which were added by sources. * * @return a list of packages, never <code>null</code> - * @see {@link #addSource(File)} - * @see {@link #addSource(Reader)} - * @see {@link #addSourceFolder(File)} - * @see {@link #addSourceTree(File)} + * @see #addSource(File) + * @see #addSource(Reader) + * @see #addSourceFolder(File) + * @see #addSourceTree(File) */ public List<JavaPackage> getPackages() { @@ -277,15 +289,17 @@ } // Searcher - + public List<JavaClass> search( Searcher searcher ) { List<JavaClass> result = new LinkedList<JavaClass>(); List<JavaClass> classArray = classLibraryBuilder.getClassLibrary().getJavaClasses(); - for (int classIndex = 0;classIndex < classArray.size(); classIndex++) { - JavaClass cls = classArray.get(classIndex); - if (searcher.eval(cls)) { - result.add(cls); + for ( int classIndex = 0; classIndex < classArray.size(); classIndex++ ) + { + JavaClass cls = classArray.get( classIndex ); + if ( searcher.eval( cls ) ) + { + result.add( cls ); } } return result; @@ -297,7 +311,8 @@ * @param file the file to serialize to * @throws IOException Any exception thrown by the underlying OutputStream */ - public void save( File file ) throws IOException + public void save( File file ) + throws IOException { FileOutputStream fos = new FileOutputStream( file ); ObjectOutputStream out = new ObjectOutputStream( fos ); @@ -315,16 +330,23 @@ /** * Note that after loading JavaDocBuilder classloaders need to be re-added. */ - public static JavaProjectBuilder load(File file) throws IOException { - FileInputStream fis = new FileInputStream(file); - ObjectInputStream in = new ObjectInputStream(fis); + public static JavaProjectBuilder load( File file ) + throws IOException + { + FileInputStream fis = new FileInputStream( file ); + ObjectInputStream in = new ObjectInputStream( fis ); JavaProjectBuilder builder; - try { + try + { ClassLibraryBuilder libraryBuilder = (ClassLibraryBuilder) in.readObject(); - builder = new JavaProjectBuilder(libraryBuilder); - } catch (ClassNotFoundException e) { - throw new Error("Couldn't load class : " + e.getMessage()); - } finally { + builder = new JavaProjectBuilder( libraryBuilder ); + } + catch ( ClassNotFoundException e ) + { + throw new Error( "Couldn't load class : " + e.getMessage() ); + } + finally + { in.close(); fis.close(); }
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/library/AbstractClassLibrary.java (1270 => 1271)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/library/AbstractClassLibrary.java 2011-07-21 20:53:40 UTC (rev 1270) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/library/AbstractClassLibrary.java 2011-07-24 12:37:17 UTC (rev 1271) @@ -74,11 +74,12 @@ * the concrete class. If there's still no JavaClass, ask the parent (if available) to resolve it. * * @param name - * @return + * @return the JavaClass matching the name, otherwise <code>null</code> */ public final JavaClass getJavaClass( String name ) { return getJavaClass( name, false ); } + public final JavaClass getJavaClass( String name, boolean createStub ) { JavaClass result = context.getClassByName( name ); if ( result == null ) @@ -124,8 +125,8 @@ * The implementation should check it's sources to see if it can build a JavaClass Model If not, just return null; * Once found it will be mapped, so there's no need to keep a reference to this object. * - * @param name - * @return + * @param name the fully qualified name + * @return the resolved JavaClass, otherwise <code>null</code> */ protected abstract JavaClass resolveJavaClass( String name ); @@ -138,7 +139,7 @@ * * * @param filter - * @return + * @return JavaSources matching the filter */ protected final List<JavaSource> getJavaSources( ClassLibraryFilter filter) { List<JavaSource> result = new LinkedList<JavaSource>(); @@ -179,7 +180,7 @@ * Subclasses can call this method to gather all JavaClass object, including those from the parent. * * @param filter - * @return + * @return JavaClasses matching the filter */ protected final List<JavaClass> getJavaClasses( ClassLibraryFilter filter) { List<JavaClass> result = new LinkedList<JavaClass>(); @@ -216,6 +217,10 @@ return context.getPackages(); } + /** + * @param name the fully qualified name + * @return the JavaPackage matching the name, otherwise <code>null</code> + */ public final JavaPackage getJavaPackage( String name ) { JavaPackage result = context.getPackageByName( name ); if (result == null) { @@ -248,6 +253,8 @@ * If not, find out if this classlibrary is able to build a model for this class * Otherwise ask the parent if it could build a JavaClass. * + * @param name the fully qualified name + * @return <code>true</code> if there is a reference, otherwise <code>false</code> */ public boolean hasClassReference( String name ) { @@ -273,7 +280,7 @@ /** * Set the ModelBuilderFactory for this classLibrary. * - * @param factory + * @param factory the model builder factory */ public final void setModelBuilderFactory( ModelBuilderFactory factory ) { this.modelBuilderFactory = factory; @@ -282,7 +289,7 @@ /** * Set the ModelWriterFactory for this class. * - * @param factory the ModelWriterFactory + * @param factory the model writer factory */ public final void setModelWriterFactory( ModelWriterFactory factory ) {
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/library/JavaClassContext.java (1270 => 1271)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/library/JavaClassContext.java 2011-07-21 20:53:40 UTC (rev 1270) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/library/JavaClassContext.java 2011-07-24 12:37:17 UTC (rev 1271) @@ -28,13 +28,12 @@ import java.util.Map; import java.util.Set; -import com.thoughtworks.qdox.model.DefaultJavaPackage; import com.thoughtworks.qdox.model.JavaClass; import com.thoughtworks.qdox.model.JavaPackage; import com.thoughtworks.qdox.model.JavaSource; /** - * JavaClassContext gives you a mechanism to get a JavaClass. + * JavaClassContext gives you a mechanism to get a {@link JavaClass}. * If a class couldn't be found in the cache, the class will be pulled from the classLibrary, the builder will create the corresponding JavaClass and put it in the cache. * * @@ -52,10 +51,10 @@ } /** - * Retrieve the {@link JavaClass} based on the name + * Retrieve the {@link JavaClass} based on the {@code name}. * * @param name the fully qualified name of the class - * @return the stored {@link JavaClass}, otherwise <code>null</code> + * @return the stored JavaClass, otherwise <code>null</code> */ public JavaClass getClassByName(String name) { @@ -63,10 +62,10 @@ } /** - * Remove and return the {@link JavaClass} based on the name + * Remove and return the {@link JavaClass} based on the {@code name}. * * @param name the fully qualified name of the class - * @return the removed {@link JavaClass}, otherwise <code>null</code> + * @return the removed JavaClass, otherwise <code>null</code> */ public JavaClass removeClassByName(String name) { @@ -76,26 +75,26 @@ /** * Return all stored JavaClasses * - * @return an array of JavaClasses, never <code>null</code> + * @return a list of JavaClasses, never <code>null</code> */ public List<JavaClass> getClasses() { return Collections.unmodifiableList( new LinkedList<JavaClass>(classMap.values()) ); } /** - * Store this JavaClass based on its fully qualified name + * Store this {@link JavaClass} based on its fully qualified name * - * @param javaClass the {@link JavaClass} to add + * @param javaClass the JavaClass to add */ public void add(JavaClass javaClass) { classMap.put(javaClass.getFullyQualifiedName(), javaClass); } /** - * Retrieve the {@link JavaPackage} based on the name + * Retrieve the {@link JavaPackage} based on the {@code name}. * * @param name the fully qualified name of the package - * @return the stored {@link JavaPackage}, otherwise <code>null</code> + * @return the stored JavaPackage, otherwise <code>null</code> */ public JavaPackage getPackageByName( String name ) { @@ -103,10 +102,10 @@ } /** - * Remove and return the {@link JavaPacakge} based on the name + * Remove and return the {@link JavaPackage} based on the {@code name}. * * @param name the fully qualified name of the class - * @return the removed {@link JavaPackage}, otherwise <code>null</code> + * @return the removed JavaPackage, otherwise <code>null</code> */ public JavaPackage removePackageByName( String name ) { @@ -114,9 +113,9 @@ } /** - * A null-safe implementation to store a JavaPackage in this context + * A null-safe implementation to store a {@link JavaPackage} in this context * - * @param jPackage the {@link JavaPackage} to add + * @param jPackage the JavaPackage to add */ public void add( JavaPackage jPackage ) { @@ -128,7 +127,7 @@ /** * Return all stored JavaPackages * - * @return an array of JavaPackages, never <code>null</code> + * @return a list of JavaPackages, never <code>null</code> */ public List<JavaPackage> getPackages() { @@ -139,7 +138,7 @@ /** * Store a {@link JavaSource} in this context * - * @param source the {@link JavaSource} to add + * @param source the JavaSource to add */ public void add( JavaSource source ) { @@ -149,7 +148,7 @@ /** * Return all stored JavaSources * - * @return an array of JavaSources, never <code>null</code> + * @return a list of JavaSources, never <code>null</code> */ public List<JavaSource> getSources() {
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/library/OrderedClassLibraryBuilder.java (1270 => 1271)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/library/OrderedClassLibraryBuilder.java 2011-07-21 20:53:40 UTC (rev 1270) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/library/OrderedClassLibraryBuilder.java 2011-07-24 12:37:17 UTC (rev 1271) @@ -66,13 +66,17 @@ * Constructor for which you can set the root ClassLibrary * If you set this to null, all classes should be available on the classpath. * - * @param classLibrary + * @param rootClassLibrary */ - public OrderedClassLibraryBuilder(AbstractClassLibrary rootClassLibrary) + public OrderedClassLibraryBuilder( AbstractClassLibrary rootClassLibrary ) { this.classLibrary = rootClassLibrary; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#appendClassLoader(java.lang.ClassLoader) + */ public ClassLibraryBuilder appendClassLoader( ClassLoader classLoader ) { if ( !( classLibrary instanceof ClassLoaderLibrary ) ) @@ -89,6 +93,10 @@ return this; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#appendDefaultClassLoaders() + */ public ClassLibraryBuilder appendDefaultClassLoaders() { if ( !( classLibrary instanceof ClassLoaderLibrary ) ) @@ -155,24 +163,40 @@ return this; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#setEncoding(java.lang.String) + */ public ClassLibraryBuilder setEncoding( String encoding ) { this.encoding = encoding; return this; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#setErrorHander(com.thoughtworks.qdox.library.ErrorHandler) + */ public ClassLibraryBuilder setErrorHander( ErrorHandler errorHandler ) { this.errorHandler = errorHandler; return this; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#setModelBuilderFactory(com.thoughtworks.qdox.builder.ModelBuilderFactory) + */ public ClassLibraryBuilder setModelBuilderFactory( ModelBuilderFactory modelBuilderFactory ) { this.modelBuilderFactory = modelBuilderFactory; return this; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#setModelWriterFactory(com.thoughtworks.qdox.writer.ModelWriterFactory) + */ public ClassLibraryBuilder setModelWriterFactory( ModelWriterFactory modelWriterFactory ) { this.modelWriterFactory = modelWriterFactory; @@ -186,7 +210,11 @@ { return classLibrary; } - + + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#appendSource(java.net.URL) + */ public ClassLibraryBuilder appendSource( URL url ) throws IOException { SourceLibrary sourceLibrary = getSourceLibrary(); @@ -194,6 +222,10 @@ return this; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#appendSource(java.io.File) + */ public ClassLibraryBuilder appendSource( File file ) throws IOException { @@ -202,24 +234,40 @@ return this; } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#addSource(java.io.InputStream) + */ public JavaSource addSource( InputStream stream ) { SourceLibrary sourceLibrary = getSourceLibrary(); return sourceLibrary.addSource( stream ); } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#addSource(java.io.Reader) + */ public JavaSource addSource( Reader reader ) { SourceLibrary sourceLibrary = getSourceLibrary(); return sourceLibrary.addSource( reader ); } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#addSource(java.net.URL) + */ public JavaSource addSource( URL url ) throws IOException { SourceLibrary sourceLibrary = getSourceLibrary(); return sourceLibrary.addSource( url ); } + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.library.ClassLibraryBuilder#addSource(java.io.File) + */ public JavaSource addSource( File file ) throws IOException {
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java (1270 => 1271)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java 2011-07-21 20:53:40 UTC (rev 1270) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java 2011-07-24 12:37:17 UTC (rev 1271) @@ -19,7 +19,6 @@ * under the License. */ -import java.lang.reflect.Modifier; import java.util.List; import com.thoughtworks.qdox.library.ClassLibrary; @@ -341,7 +340,7 @@ * Equivalent of {@link Class#getModifiers()} * * <strong>This does not follow the java-api</strong> - * The Class.getModifiers() returns an <code>int</code>, which should be decoded with the {@link Modifier}. + * The Class.getModifiers() returns an <code>int</code>, which should be decoded with the {@link java.lang.reflect.Modifier}. * This method will return a list of strings representing the modifiers. * If this member was extracted from a source, it will keep its order. * Otherwise if will be in the preferred order of the java-api. @@ -351,7 +350,7 @@ List<String> getModifiers(); /** - * (API description of {@link Modifier#isPublic(int)}) + * (API description of {@link java.lang.reflect.Modifier#isPublic(int)}) * <p> * Return <code>true</code> if the class includes the public modifier, <code>false</code> otherwise. * <p> @@ -361,7 +360,7 @@ boolean isPublic(); /** - * (API description of {@link Modifier#isProtected(int)}) + * (API description of {@link java.lang.reflect.Modifier#isProtected(int)}) * <p> * Return <code>true</code> if the class includes the protected modifier, <code>false</code> otherwise. * </p> @@ -371,7 +370,7 @@ boolean isProtected(); /** - * (API description of {@link Modifier#isPrivate(int)}) + * (API description of {@link java.lang.reflect.Modifier#isPrivate(int)}) * <p> * Return <code>true</code> if the class includes the private modifier, <code>false</code> otherwise. * </p> @@ -381,7 +380,7 @@ boolean isPrivate(); /** - * (API description of {@link Modifier#isFinal(int)}) + * (API description of {@link java.lang.reflect.Modifier#isFinal(int)}) * <p> * Return <code>true</code> if the class includes the final modifier, <code>false</code> otherwise. * </p> @@ -391,7 +390,7 @@ boolean isFinal(); /** - * (API description of {@link Modifier#isStatic((int)}) + * (API description of {@link java.lang.reflect.Modifier#isStatic(int)}) * <p> * Return <code>true</code> if the class includes the static modifier, <code>false</code> otherwise. * </p> @@ -401,7 +400,7 @@ boolean isStatic(); /** - * (API description of {@link Modifier#isAbstract(int)}) + * (API description of {@link java.lang.reflect.Modifier#isAbstract(int)}) * * Return <code>true</code> if the class includes the abstract modifier, <code>false</code> otherwise. *
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java (1270 => 1271)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java 2011-07-21 20:53:40 UTC (rev 1270) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java 2011-07-24 12:37:17 UTC (rev 1271) @@ -19,12 +19,10 @@ * under the License. */ -import java.lang.reflect.Member; -import java.lang.reflect.Modifier; import java.util.List; /** - * JavaModel representation of a {@link Member} including related methods of {@ Modifier} + * JavaModel representation of a {@link java.lang.reflect.Member} including related methods of {@link java.lang.reflect.Modifier} * * @author Robert Scholte * @since 2.0 @@ -32,10 +30,10 @@ public interface JavaMember { /** - * Equivalent of {@link Member#getModifiers()} + * Equivalent of {@link java.lang.reflect.Member#getModifiers()} * * <strong>This does not follow the java-api</strong> - * With the {@link Member}-class, getModifiers returns an <code>int</code>, which should be decoded with the {@link Modifier} + * With the Member-class, getModifiers returns an <code>int</code>, which should be decoded with the Modifier. * If this member was extracted from a source, it will keep its order. * Otherwise if will be in the preferred order of the java-api. * @@ -44,93 +42,93 @@ List<String> getModifiers(); /** - * Equivalent of {@link Member#getDeclaringClass()} + * Equivalent of {@link java.lang.reflect.Member#getDeclaringClass()} * * @return */ JavaClass getDeclaringClass(); /** - * Equivalent of {@link Member#getName()} + * Equivalent of {@link java.lang.reflect.Member#getName()} * * @return the name of this member */ String getName(); /** - * Equivalent of {@link Modifier#isAbstract(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isAbstract(int)} * - * @return <tt>true</tt> if this member is <tt>abstract</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>abstract</code>, otherwise <code>false</code> */ boolean isAbstract(); /** - * Equivalent of {@link Modifier#isFinal(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isFinal(int)} * - * @return <tt>true</tt> is this member is <tt>final</tt>; otherwise <tt>false</tt> + * @return <code>true</code> is this member is <code>final</code>, otherwise <code>false</code> */ boolean isFinal(); /** - * Equivalent of {@link Modifier#isNative(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isNative(int)} * - * @return <tt>true</tt> if this member is <tt>native</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>native</code>, otherwise <code>false</code> */ boolean isNative(); /** - * Equivalent of {@link Modifier#isPrivate(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isPrivate(int)} * - * @return <tt>true</tt> if this member is <tt>private</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>private</code>, otherwise <code>false</code> */ boolean isPrivate(); /** - * Equivalent of {@link Modifier#isProtected(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isProtected(int)} * - * @return <tt>true</tt> if this member is <tt>protected</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>protected</code>; otherwise <code>false</code> */ boolean isProtected(); /** - * Equivalent of {@link Modifier#isPublic(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isPublic(int)} * - * @return <tt>true</tt> if this member is <tt>public</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>public</code>, otherwise <code>false</code> */ boolean isPublic(); /** - * Equivalent of {@link Modifier#isStatic(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isStatic(int)} * - * @return <tt>true</tt> if this member is <tt>static</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>static</code>, otherwise <code>false</code> */ boolean isStatic(); /** - * Equivalent of {@link Modifier#isStrict(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isStrict(int)} * - * @return <tt>true</tt> if this member is <tt>strictfp</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>strictfp</code>, otherwise <code>false</code> */ boolean isStrictfp(); /** - * Equivalent of {@link Modifier#isSynchronized(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isSynchronized(int)} * - * @return <tt>true</tt> if this member is <tt>synchronized</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>synchronized</code>, otherwise <code>false</code> */ boolean isSynchronized(); /** - * Equivalent of {@link Modifier#isTransient(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isTransient(int)} * - * @return <tt>true</tt> if this member is <tt>transient</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>transient</code>, otherwise <code>false</code> */ boolean isTransient(); /** - * Equivalent of {@link Modifier#isVolatile(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isVolatile(int)} * - * @return <tt>true</tt> if this member is <tt>volatile</tt>; otherwise <tt>false</tt> + * @return <code>true</code> if this member is <code>volatile</code>, otherwise <code>false</code> */ boolean isVolatile();
To unsubscribe from this list please visit:
