Author: tchemit Date: 2009-08-26 21:07:41 +0200 (Wed, 26 Aug 2009) New Revision: 260 Modified: trunk/nuiton-processor/src/main/java/org/nuiton/processor/Processor.java trunk/nuiton-processor/src/main/java/org/nuiton/processor/ProcessorReader.java trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/Filter.java trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/NoActionFilter.java Log: - reformat code - add javadoc - use Log from commons-logging instead of Logger api Modified: trunk/nuiton-processor/src/main/java/org/nuiton/processor/Processor.java =================================================================== --- trunk/nuiton-processor/src/main/java/org/nuiton/processor/Processor.java 2009-08-22 23:01:22 UTC (rev 259) +++ trunk/nuiton-processor/src/main/java/org/nuiton/processor/Processor.java 2009-08-26 19:07:41 UTC (rev 260) @@ -32,16 +32,18 @@ import org.nuiton.processor.filters.*; import org.nuiton.processor.filters.Filter; import java.io.*; -import java.util.logging.Logger; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; -/* - * This class is a generic sources processor - * Given a reader class name and a writer class name +/** + * This class is a generic sources processor given + * a reader class name and a writer class name. + * */ public class Processor { /** to use log facility, just put in your code: log.info(\"...\"); */ - static private Logger log = Logger.getLogger("org.nuiton.processor.Processor"); + static private final Log log = LogFactory.getLog(Processor.class); protected Filter[] inputFilter = new Filter[]{new NoActionFilter()}; protected Filter outputFilter = new NoActionFilter(); @@ -72,23 +74,31 @@ return result; } - /** Process all available data - * @param externalInput - * @param externalOutput + /** + * Process all available data. + * + * @param externalInput the reader + * @param externalOutput the writer * @throws IOException if any pb */ public void process(Reader externalInput, Writer externalOutput) throws IOException { - log.finest("Debug du process"); + if (log.isTraceEnabled()) { + log.trace("Debug du process"); + } BufferedReader input = getReader(externalInput); ProcessorWriter output = new ProcessorWriter(new BufferedWriter(externalOutput), outputFilter); - log.finest("input: " + input); - log.finest("output: " + output); + if (log.isTraceEnabled()) { + log.trace("input: " + input); + log.trace("output: " + output); + } String line = input.readLine(); while (line != null) { - log.finest("Ligne lu: " + line); + if (log.isTraceEnabled()) { + log.trace("Ligne lu: " + line); + } output.writeLine(line); line = input.readLine(); } Modified: trunk/nuiton-processor/src/main/java/org/nuiton/processor/ProcessorReader.java =================================================================== --- trunk/nuiton-processor/src/main/java/org/nuiton/processor/ProcessorReader.java 2009-08-22 23:01:22 UTC (rev 259) +++ trunk/nuiton-processor/src/main/java/org/nuiton/processor/ProcessorReader.java 2009-08-26 19:07:41 UTC (rev 260) @@ -16,18 +16,17 @@ * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* */ /* * -* ProcessorReader.java -* -* Created: Wed Jan 14 2004 -* -* @author <poussin@codelutin.com> -* Copyright Code Lutin -* @version $Revision$ -* -* Mise a jour: $Date$ -* par : $Author$ -*/ - + * ProcessorReader.java + * + * Created: Wed Jan 14 2004 + * + * @author <poussin@codelutin.com> + * Copyright Code Lutin + * @version $Revision$ + * + * Mise a jour: $Date$ + * par : $Author$ + */ package org.nuiton.processor; import java.io.BufferedReader; @@ -36,13 +35,18 @@ import org.nuiton.processor.filters.Filter; +/** + * TODO doc. + * + * @author poussin + */ public class ProcessorReader extends BufferedReader { protected BufferedReader input; protected Filter filter; protected String lineSeparator; - protected ProcessorReader(){ + protected ProcessorReader() { super(new StringReader("")); } @@ -53,12 +57,12 @@ lineSeparator = System.getProperty("line.separator"); } - public void setInput(BufferedReader input){ + public void setInput(BufferedReader input) { this.input = input; } @Override - public boolean markSupported(){ + public boolean markSupported() { return false; } @@ -66,18 +70,18 @@ public String readLine() throws IOException { if (input.ready()) { String line = input.readLine(); - if(line != null){ - if (!(input instanceof ProcessorReader)){ + if (line != null) { + if (!(input instanceof ProcessorReader)) { line += lineSeparator; } - return filter.parse(line); + String parse = filter.parse(line); + return parse; } } - if(filter.hasCachedData()){ + if (filter.hasCachedData()) { return filter.flush(); - } else { - return null; } + return null; } @Override @@ -97,5 +101,4 @@ public void close() throws IOException { input.close(); } - } Modified: trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/Filter.java =================================================================== --- trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/Filter.java 2009-08-22 23:01:22 UTC (rev 259) +++ trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/Filter.java 2009-08-26 19:07:41 UTC (rev 260) @@ -16,26 +16,44 @@ * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* */ /* * -* Filter.java -* -* Created: Wed Jan 14 2004 -* -* @author <poussin@codelutin.com> -* Copyright Code Lutin -* @version $Revision$ -* -* Mise a jour: $Date$ -* par : $Author$ -*/ - + * Filter.java + * + * Created: Wed Jan 14 2004 + * + * @author <poussin@codelutin.com> + * Copyright Code Lutin + * @version $Revision$ + * + * Mise a jour: $Date$ + * par : $Author$ + */ package org.nuiton.processor.filters; +/** + * TODO doc + * + * @author poussin + */ public interface Filter { final static String EMPTY_STRING = ""; - String parse (String input); + /** + * + * @param input la chaine de caractère à processer + * @return la chaine processée + */ + String parse(String input); + + /** + * + * @return <code>true</code> si le filtre contient des données en cache + */ boolean hasCachedData(); - String flush (); + /** + * + * @return la chaine de caractères + */ + String flush(); } Modified: trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/NoActionFilter.java =================================================================== --- trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/NoActionFilter.java 2009-08-22 23:01:22 UTC (rev 259) +++ trunk/nuiton-processor/src/main/java/org/nuiton/processor/filters/NoActionFilter.java 2009-08-26 19:07:41 UTC (rev 260) @@ -16,35 +16,37 @@ * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* */ /* * -* NoActionFilter.java -* -* Created: Wed Jan 14 2004 -* -* @author <poussin@codelutin.com> -* Copyright Code Lutin -* @version $Revision$ -* -* Mise a jour: $Date$ -* par : $Author$ -*/ - + * NoActionFilter.java + * + * Created: Wed Jan 14 2004 + * + * @author <poussin@codelutin.com> + * Copyright Code Lutin + * @version $Revision$ + * + * Mise a jour: $Date$ + * par : $Author$ + */ package org.nuiton.processor.filters; -/* -* This class deals with the -*/ +/** + * This filter does nothing on input. + * + */ public class NoActionFilter implements Filter { - public String parse (String input) { + @Override + public String parse(String input) { return input; } - public boolean hasCachedData(){ + @Override + public boolean hasCachedData() { return false; } - public String flush (){ - return EMPTY_STRING; + @Override + public String flush() { + return DefaultFilter.EMPTY_STRING; } - }