classesimports
addClass (...)addImport (...)addJavadocPackage (...)addJavadocSet (...)clearImports (...)findClass (...)0001/* 0002 * Java2Web - A configurable Java to HTML source code converter. 0003 * Copyright (c) 2006 Alexander Hristov. 0004 * 0005 * This program is free software; you can redistribute it and/or 0006 * modify it under the terms of the GNU General Public License 0007 * as published by the Free Software Foundation; either version 2 0008 * of the License, or (at your option) any later version. 0009 * 0010 * This program is distributed in the hope that it will be useful, 0011 * but WITHOUT ANY WARRANTY; without even the implied warranty of 0012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 0013 * GNU General Public License for more details. 0014 * 0015 * You should have received a copy of the GNU General Public License 0016 * along with this program; if not, write to the Free Software 0017 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 0018 * 0019 */0020package org.java2web.html; 0021 0022import java.io.BufferedReader; 0023import java.io.File; 0024import java.io.FileReader; 0025import java.io.IOException; 0026import java.util.ArrayList; 0027import java.util.HashMap; 0028 0029/** 0030 * This class handless a repository of known to the system. This repository is later used in order 0031 * to convert simple class names to fully qualified ones, thus determining which javadoc link them 0032 * to. 0033 * @author Alexander Hristov 0034 * 0035 */0036public class ClassResolver { 0037/** 0038 * Hashmap linking simple class names to the possible fully qualified ones. For example: <br/> 0039 * (Date -> (java.sql.Date, java.util.Date)) 0040 * 0041 */0042 protected HashMap<String, ArrayList<String>> classes = new HashMap<String,ArrayList<String>>(); 0043 0044 0047 protected ArrayList<String> imports = new ArrayList<String>(); 0048 0049 0050/** 0051 * Adds a fully qualified class name to the list of classes recognized by the resolver 0052 * @param className Fully qualified class name 0053 */0054 public void addClass(String className) { 0055 int dot = className.lastIndexOf("."); 0056 if (dot == -1) throw new IllegalArgumentException("The class name must be fully qualified, and it is not ("+className+")"); 0057 String simpleClassName = className.substring(dot+1); 0058 ArrayList<String> possibilities = classes.get(simpleClassName); 0059 if (possibilities == null) { 0060 possibilities = new ArrayList<String>(); 0061 classes.put(simpleClassName,possibilities); 0062 } 0063 possibilities.add(className); 0064 } 0065 0066/** 0067 * Reads all classes from a single javadoc package directory 0068 * @param rootPath Root path of the javadoc tree (E.g. "c:\java\doc") 0069 * @param packageName Package name whose contents we want to read (E.G "java.lang") 0070 * @return number of classes read 0071 */0072 public int addJavadocPackage(String rootPath, String packageName ) { 0073 int read = 0; 0074 File packagePath = new File(rootPath,packageName.replace('.',File.separatorChar)); 0075 if (!packagePath.exists()) return 0; 0076 String[] contents = packagePath.list(); 0077 for (String name : contents) { 0078 int dot = name.indexOf("."); 0079 if (dot == -1) continue; 0080 String extension = name.substring(dot+1).toUpperCase(); 0081 if (!extension.equals("HTML")) continue; 0082 addClass(packageName+"."+name.substring(0,dot)); 0083 read++; 0084 } 0085 return read; 0086 } 0087 0088/** 0089 * Reads all classes in all packages described in the package-list file of the specified root path. 0090 * Does nothing if the specified path does not contain a package-list file 0091 * @param rootPath Root path of the javadoc tree (E.g. "c:\java\doc") 0092 * @return number of classes read 0093 * @throws IOException If an I/O error occurs 0094 */0095 public int addJavadocSet(String rootPath) throws IOException { 0096 int read = 0; 0097 File packageList = new File(rootPath,"package-list"); 0098 if (!packageList.exists()) return 0; 0099 BufferedReader in = null; 0100 try { 0101 in = new BufferedReader(new FileReader(packageList)); 0102 String packageName; 0103 while ( (packageName = in.readLine()) != null) { 0104 read += addJavadocPackage(rootPath,packageName); 0105 } 0106 } finally { 0107 if (in != null) try { in.close(); } catch (IOException e) {} 0108 } 0109 return read; 0110 } 0111 0112/** 0113 * Adds an import to the list of imports recognized by the resolver. 0114 * @param importSequence what was imported. NEITHER the "import" keyword NOR the ending 0115 * semicolon must NOT be included. 0116 */0117 public void addImport(String importSequence) { 0118 importSequence = importSequence.trim(); 0119 if (importSequence.endsWith(".*")) { 0120 importSequence = importSequence.substring(0,importSequence.length()-2); 0121 } 0122 imports.add(importSequence); 0123 } 0124 0125 0128 public void clearImports() { 0129 imports.clear(); 0130 } 0131 0132/** 0133 * Given a simple class name, analyzing the available classes AND the imports, determines which is 0134 * the fully qualified class name 0135 * @param className Simple unqualified class name (e.g.:"String") 0136 * @return Fully qualified class name ("java.lang.String") OR null if the class could not be resolved 0137 */0138 public String findClass(String className) { 0139// Is it already qualified?0140 if (className.indexOf(".") != -1) 0141 return className; 0142 0143// See if we have an explicit import0144 for (String imp : imports ) { 0145 if (imp.endsWith("."+className)) 0146 return imp; 0147 } 0148 0149 0150// No implicit import - we must search the list of previously read classes0151 ArrayList<String> possibilities = classes.get(className); 0152 0153// If we have nothing for this class, then we cannot recognize the package0154 if (possibilities == null) return null; 0155 0156 0157// If there is only one variant, link to it.0158// We might be tempted to check whether this package has been really imported, but this is not0159// appropriate for two reasons:0160// - The class we are parsing might have resided in the same package as the one we are looking for - thus no import0161// - We might be converting into HTML just a code snippet, so we might not be seeing any imports0162 if (possibilities.size() == 1) 0163 return possibilities.get(0);// fqcn = fully qualified class name0164 0165 0166// We have several possibilites. See which one we have imported0167 for (String qualifiedClassName : possibilities) { 0168 int dot = qualifiedClassName.lastIndexOf("."); 0169 String packageName = qualifiedClassName.substring(0,dot); 0170 for (String imp : imports) { 0171 if (imp.equals(packageName)) return qualifiedClassName; 0172 } 0173 } 0174 0175// We have several possibilities, but none of them was explicitly imported. In such case0176// test if one of the possibilities is java.lang - which does not need an explicit import0177 for (String qualifiedClassName : possibilities) { 0178 if (qualifiedClassName.equals("java.lang."+className)) 0179 return "java.lang."+className; 0180 } 0181 return null; 0182 } 0183} 0184
classesimportsaddClass (...)addImport (...)addJavadocPackage (...)addJavadocSet (...)clearImports (...)findClass (...)