Repository: any23 Updated Branches: refs/heads/master 120b5a4fd -> bb5568585
http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/rdf/RDFUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/rdf/RDFUtils.java b/core/src/main/java/org/apache/any23/rdf/RDFUtils.java index 633f2cb..7244bdb 100644 --- a/core/src/main/java/org/apache/any23/rdf/RDFUtils.java +++ b/core/src/main/java/org/apache/any23/rdf/RDFUtils.java @@ -85,8 +85,9 @@ public class RDFUtils { * @param dateToBeParsed the String containing the date. * @param format the pattern as descibed in {@link java.text.SimpleDateFormat} * @return a {@link String} representing the date - * @throws java.text.ParseException - * @throws javax.xml.datatype.DatatypeConfigurationException + * @throws java.text.ParseException if there is an error parsing the given date. + * @throws javax.xml.datatype.DatatypeConfigurationException if there is a serious + * configuration error. */ public static String getXSDDate(String dateToBeParsed, String format) throws ParseException, DatatypeConfigurationException { @@ -114,17 +115,14 @@ public class RDFUtils { } /** - * Tries to fix a potentially broken relative or absolute URI. - * - * <p/> + * <p>Tries to fix a potentially broken relative or absolute URI.</p> * These appear to be good rules: * Remove whitespace or '\' or '"' in beginning and end * Replace space with %20 * Drop the triple if it matches this regex (only protocol): ^[a-zA-Z0-9]+:(//)?$ * Drop the triple if it matches this regex: ^javascript: - * Truncate ">.*$ from end of lines (Neko didn't quite manage to fix broken markup) - * Drop the triple if any of these appear in the URL: <>[]|*{}"<>\ - * <p/> + * Truncate ">.*$ from end of lines (Neko didn't quite manage to fix broken markup) + * Drop the triple if any of these appear in the URL: <>[]|*{}"<>\ * * @param unescapedURI uri string to be unescaped. * @return the unescaped string. @@ -170,6 +168,8 @@ public class RDFUtils { /** * Creates a {@link URI}. + * @param uri string representation of the {@link URI} + * @return a valid {@link URI} */ public static URI uri(String uri) { return valueFactory.createURI(uri); @@ -177,6 +177,9 @@ public class RDFUtils { /** * Creates a {@link URI}. + * @param namespace a base namespace for the {@link URI} + * @param localName a local name to associate with the namespace + * @return a valid {@link URI} */ public static URI uri(String namespace, String localName) { return valueFactory.createURI(namespace, localName); @@ -184,6 +187,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param s string representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(String s) { return valueFactory.createLiteral(s); @@ -191,6 +196,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param b boolean representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(boolean b) { return valueFactory.createLiteral(b); @@ -198,6 +205,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param b byte representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(byte b) { return valueFactory.createLiteral(b); @@ -205,6 +214,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param s short representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(short s) { return valueFactory.createLiteral(s); @@ -212,6 +223,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param i int representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(int i) { return valueFactory.createLiteral(i); @@ -219,6 +232,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param l long representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(long l) { return valueFactory.createLiteral(l); @@ -226,6 +241,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param f float representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(float f) { return valueFactory.createLiteral(f); @@ -233,6 +250,8 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param d double representation of the {@link org.openrdf.model.Literal} + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(double d) { return valueFactory.createLiteral(d); @@ -240,6 +259,10 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param s string representation of the base namespace for the + * {@link org.openrdf.model.Literal} + * @param l the local name to associate with the namespace. + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(String s, String l) { return valueFactory.createLiteral(s, l); @@ -247,6 +270,10 @@ public class RDFUtils { /** * Creates a {@link Literal}. + * @param s string representation of the base namespace for the + * {@link org.openrdf.model.Literal} + * @param datatype the datatype to associate with the namespace. + * @return valid {@link org.openrdf.model.Literal} */ public static Literal literal(String s, URI datatype) { return valueFactory.createLiteral(s, datatype); @@ -254,6 +281,8 @@ public class RDFUtils { /** * Creates a {@link BNode}. + * @param id string representation of the {@link org.openrdf.model.BNode} + * @return the valid {@link org.openrdf.model.BNode} */ // TODO: replace this with all occurrences of #getBNode() public static BNode bnode(String id) { @@ -269,6 +298,9 @@ public class RDFUtils { /** * Creates a {@link BNode}. + * @param id string representation of the {@link org.openrdf.model.BNode} + * name for which we will create a md5 hash. + * @return the valid {@link org.openrdf.model.BNode} */ public static BNode getBNode(String id) { return valueFactory.createBNode( @@ -278,6 +310,10 @@ public class RDFUtils { /** * Creates a {@link Statement}. + * @param s subject {@link org.openrdf.model.Resource} + * @param p predicate {@link org.openrdf.model.URI} + * @param o object {@link org.openrdf.model.Value} + * @return valid {@link org.openrdf.model.Statement} */ public static Statement triple(Resource s, URI p, Value o) { return valueFactory.createStatement(s, p, o); @@ -297,6 +333,11 @@ public class RDFUtils { /** * Creates a {@link Statement}. + * @param s subject. + * @param p predicate. + * @param o object. + * @param g quad resource + * @return a statement instance. */ public static Statement quad(Resource s, URI p, Value o, Resource g) { return valueFactory.createStatement(s, p, o, g); @@ -304,6 +345,11 @@ public class RDFUtils { /** * Creates a statement of type: <code>toValue(s), toValue(p), toValue(o), toValue(g)</code> + * @param s subject. + * @param p predicate. + * @param o object. + * @param g quad resource + * @return a statement instance. */ public static Statement quad(String s, String p, String o, String g) { return valueFactory.createStatement((Resource) toValue(s), (URI) toValue(p), toValue(o), (Resource) toValue(g)); @@ -314,7 +360,7 @@ public class RDFUtils { * an {@link RDF#TYPE}. If <code> s.matches('[a-z0-9]+:.*')</code> * expands the corresponding prefix using {@link PopularPrefixes}. * - * @param s + * @param s string representation of value. * @return a value instance. */ public static Value toValue(String s) { @@ -388,12 +434,12 @@ public class RDFUtils { * specified parser <code>p</code> using <code>baseURI</code>. * * @param format input format type. - * @param is input stream containing <code>RDF</data>. + * @param is input stream containing <code>RDF</code>. * @param baseURI base uri. * @return list of statements detected within the input stream. - * @throws RDFHandlerException - * @throws IOException - * @throws RDFParseException + * @throws RDFHandlerException if there is an error handling the RDF + * @throws IOException if there is an error reading the {@link java.io.InputStream} + * @throws RDFParseException if there is an error handling the RDF */ public static Statement[] parseRDF(RDFFormat format, InputStream is, String baseURI) throws RDFHandlerException, IOException, RDFParseException { @@ -412,11 +458,11 @@ public class RDFUtils { * specified parser <code>p</code> using <code>''</code> as base URI. * * @param format input format type. - * @param is input stream containing <code>RDF</data>. + * @param is input stream containing <code>RDF</code>. * @return list of statements detected within the input stream. - * @throws RDFHandlerException - * @throws IOException - * @throws RDFParseException + * @throws RDFHandlerException if there is an error handling the RDF + * @throws IOException if there is an error reading the {@link java.io.InputStream} + * @throws RDFParseException if there is an error handling the RDF */ public static Statement[] parseRDF(RDFFormat format, InputStream is) throws RDFHandlerException, IOException, RDFParseException { @@ -428,11 +474,11 @@ public class RDFUtils { * specified parser <code>p</code> using <code>''</code> as base URI. * * @param format input format type. - * @param in input string containing <code>RDF</data>. + * @param in input string containing <code>RDF</code>. * @return list of statements detected within the input string. - * @throws RDFHandlerException - * @throws IOException - * @throws RDFParseException + * @throws RDFHandlerException if there is an error handling the RDF + * @throws IOException if there is an error reading the {@link java.io.InputStream} + * @throws RDFParseException if there is an error handling the RDF */ public static Statement[] parseRDF(RDFFormat format, String in) throws RDFHandlerException, IOException, RDFParseException { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/util/DiscoveryUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/util/DiscoveryUtils.java b/core/src/main/java/org/apache/any23/util/DiscoveryUtils.java index 8144c0d..fa919e0 100644 --- a/core/src/main/java/org/apache/any23/util/DiscoveryUtils.java +++ b/core/src/main/java/org/apache/any23/util/DiscoveryUtils.java @@ -47,7 +47,6 @@ public class DiscoveryUtils { * * @param packageName the root package. * @return list of matching classes. - * @throws IOException */ public static List<Class> getClassesInPackage(String packageName) { final ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/util/FileUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/util/FileUtils.java b/core/src/main/java/org/apache/any23/util/FileUtils.java index c41c47c..b31898f 100644 --- a/core/src/main/java/org/apache/any23/util/FileUtils.java +++ b/core/src/main/java/org/apache/any23/util/FileUtils.java @@ -65,8 +65,8 @@ public class FileUtils { * Copies the content of the input stream within the given dest file. * The dest file must not exist. * - * @param is - * @param dest + * @param is {@link java.io.InputStream} to copy + * @param dest detination to copy it to. */ public static void cp(InputStream is, File dest) { if (dest.exists()) { @@ -117,7 +117,7 @@ public class FileUtils { * * @param f file target. * @param content content to be dumped. - * @throws IOException + * @throws IOException if there is an error dumping the content */ public static void dumpContent(File f, String content) throws IOException { FileWriter fw = new FileWriter(f); @@ -133,7 +133,7 @@ public class FileUtils { * * @param f file to generate dump. * @param t exception to be dumped. - * @throws IOException + * @throws IOException if there is an error dumping the content */ public static void dumpContent(File f, Throwable t) throws IOException { final ByteArrayOutputStream baos = new ByteArrayOutputStream(); @@ -149,7 +149,7 @@ public class FileUtils { * @param clazz the class to use load the resource. * @param resource the resource to be load. * @return the string representing the file content. - * @throws java.io.IOException + * @throws java.io.IOException if there is an error loading the resource */ public static String readResourceContent(Class clazz, String resource) throws IOException { return StreamUtils.asString( clazz.getResourceAsStream(resource) ); @@ -160,7 +160,7 @@ public class FileUtils { * * @param resource the resource to be load. * @return the string representing the file content. - * @throws java.io.IOException + * @throws java.io.IOException if there is an error loading the resource */ public static String readResourceContent(String resource) throws IOException { return readResourceContent(FileUtils.class, resource); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/util/StreamUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/util/StreamUtils.java b/core/src/main/java/org/apache/any23/util/StreamUtils.java index cfdb73f..2022f0e 100644 --- a/core/src/main/java/org/apache/any23/util/StreamUtils.java +++ b/core/src/main/java/org/apache/any23/util/StreamUtils.java @@ -44,7 +44,7 @@ public class StreamUtils { * * @param is input stream. * @return list of not <code>null</code> lines. - * @throws IOException + * @throws IOException if an error occurs while consuming the <code>is</code> stream. */ public static String[] asLines(InputStream is) throws IOException { final BufferedReader br = new BufferedReader(new InputStreamReader(is)); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/util/StringUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/util/StringUtils.java b/core/src/main/java/org/apache/any23/util/StringUtils.java index 0528db0..96eefc2 100644 --- a/core/src/main/java/org/apache/any23/util/StringUtils.java +++ b/core/src/main/java/org/apache/any23/util/StringUtils.java @@ -79,8 +79,8 @@ public class StringUtils { /** * Check whether string <code>candidatePrefix</code> is prefix of string <code>container</code>. * - * @param candidatePrefix - * @param container + * @param candidatePrefix prefix to check + * @param container container to check against * @return <code>true</code> if <code>candidatePrefix</code> is prefix of <code>container</code>, * <code>false</code> otherwise. */ @@ -102,8 +102,8 @@ public class StringUtils { /** * Check whether string <code>candidateSuffix</code> is suffix of string <code>container</code>. * - * @param candidateSuffix - * @param container + * @param candidateSuffix suffix to check + * @param container container to check against * @return <code>true</code> if <code>candidateSuffix</code> is prefix of <code>container</code>, * <code>false</code> otherwise. */ @@ -157,7 +157,7 @@ public class StringUtils { } /** - * Builds a string composed of the given char <code>c<code/> <code>n</code> times. + * Builds a string composed of the given char <code>c</code> <code>n</code> times. * * @param c char to be multiplied. * @param times number of times. http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/validator/DOMDocument.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/validator/DOMDocument.java b/core/src/main/java/org/apache/any23/validator/DOMDocument.java index 884870d..8c1ba59 100644 --- a/core/src/main/java/org/apache/any23/validator/DOMDocument.java +++ b/core/src/main/java/org/apache/any23/validator/DOMDocument.java @@ -74,7 +74,7 @@ public interface DOMDocument { * Returns all the nodes declaring an attribute with the specified name. * * @param attrName name of attribute to use for filtering. - * @return a list of nodes. <code>null</node> if no matches found. + * @return a list of nodes. <i>null</i> if no matches found. */ List<Node> getNodesWithAttribute(String attrName); } http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/validator/RuleContext.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/validator/RuleContext.java b/core/src/main/java/org/apache/any23/validator/RuleContext.java index af44a93..f88e4ed 100644 --- a/core/src/main/java/org/apache/any23/validator/RuleContext.java +++ b/core/src/main/java/org/apache/any23/validator/RuleContext.java @@ -30,15 +30,15 @@ public interface RuleContext <T> { /** * Puts a data within the context. * - * @param name - * @param value + * @param name rule key + * @param value rule value */ void putData(String name, T value); /** * Retrieves a registered object. * - * @param name + * @param name rule key * @return a registered object, <code>null</code> if not found. */ T getData(String name); @@ -46,7 +46,7 @@ public interface RuleContext <T> { /** * Removes a data from the context. * - * @param name + * @param name remove entry with this name */ void removeData(String name); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/validator/ValidationReportSerializer.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/validator/ValidationReportSerializer.java b/core/src/main/java/org/apache/any23/validator/ValidationReportSerializer.java index 0b1b446..ec76d49 100644 --- a/core/src/main/java/org/apache/any23/validator/ValidationReportSerializer.java +++ b/core/src/main/java/org/apache/any23/validator/ValidationReportSerializer.java @@ -31,6 +31,7 @@ public interface ValidationReportSerializer { * * @param vr the validation report to be serialized. * @param os the output stream used to produce the serialization. + * @throws SerializationException if there is an error serializing data */ void serialize(ValidationReport vr, OutputStream os) throws SerializationException; http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/validator/Validator.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/validator/Validator.java b/core/src/main/java/org/apache/any23/validator/Validator.java index 88ea3b3..6e2eb9f 100644 --- a/core/src/main/java/org/apache/any23/validator/Validator.java +++ b/core/src/main/java/org/apache/any23/validator/Validator.java @@ -57,22 +57,22 @@ public interface Validator { /** * Allows to register a new rule to this validator * - * @param rule + * @param rule add a configured {@link org.apache.any23.validator.Rule} */ void addRule(Class<? extends Rule> rule); /** * Allows to register a new rule to this validator and associating it to a fix. * - * @param rule - * @param fix + * @param rule add a configured {@link org.apache.any23.validator.Rule} + * @param fix add a configured {@link org.apache.any23.validator.Fix} for the rule */ void addRule(Class<? extends Rule> rule, Class<? extends Fix> fix); /** * Allows to remove a rule from the validator and all the related {@link Fix}es. * - * @param rule + * @param rule {@link org.apache.any23.validator.Rule} to remove */ void removeRule(Class<? extends Rule> rule); @@ -86,7 +86,7 @@ public interface Validator { /** * Returns all fixes registered for the give rule. * - * @param rule + * @param rule {@link org.apache.any23.validator.Rule} to obtain fixes for. * @return a not null list of fixes. */ List<Class<? extends Fix>> getFixes(Class<? extends Rule> rule); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/vocab/RDFSchemaUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/vocab/RDFSchemaUtils.java b/core/src/main/java/org/apache/any23/vocab/RDFSchemaUtils.java index fe31405..50e5cac 100644 --- a/core/src/main/java/org/apache/any23/vocab/RDFSchemaUtils.java +++ b/core/src/main/java/org/apache/any23/vocab/RDFSchemaUtils.java @@ -53,7 +53,7 @@ public class RDFSchemaUtils { * @param properties list of properties. * @param comments map of resource comments. * @param writer writer to print out the RDF Schema triples. - * @throws RDFHandlerException + * @throws RDFHandlerException if there is an error handling the RDF */ public static void serializeVocabulary( URI namespace, @@ -85,7 +85,7 @@ public class RDFSchemaUtils { * * @param vocabulary vocabulary to be serialized. * @param writer output writer. - * @throws RDFHandlerException + * @throws RDFHandlerException if there is an error handling the RDF */ public static void serializeVocabulary(Vocabulary vocabulary, RDFWriter writer) throws RDFHandlerException { @@ -105,7 +105,7 @@ public class RDFSchemaUtils { * @param format output format for vocabulary. * @param willFollowAnother if <code>true</code> another vocab will be printed in the same stream. * @param ps output stream. - * @throws RDFHandlerException + * @throws RDFHandlerException if there is an error handling the RDF */ public static void serializeVocabulary( Vocabulary vocabulary, @@ -132,7 +132,7 @@ public class RDFSchemaUtils { * @param vocabulary vocabulary to be serialized. * @param format output format for vocabulary. * @return string contained serialization. - * @throws RDFHandlerException + * @throws RDFHandlerException if there is an error handling the RDF */ public static String serializeVocabulary(Vocabulary vocabulary, RDFFormat format) throws RDFHandlerException { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/core/src/main/java/org/apache/any23/writer/BenchmarkTripleHandler.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/any23/writer/BenchmarkTripleHandler.java b/core/src/main/java/org/apache/any23/writer/BenchmarkTripleHandler.java index f96f47b..2bc3640 100644 --- a/core/src/main/java/org/apache/any23/writer/BenchmarkTripleHandler.java +++ b/core/src/main/java/org/apache/any23/writer/BenchmarkTripleHandler.java @@ -46,6 +46,7 @@ public class BenchmarkTripleHandler implements TripleHandler { /** * Constructor. + * @param tripleHandler a configured {@link org.apache.any23.writer.TripleHandler} */ public BenchmarkTripleHandler(TripleHandler tripleHandler) { if(tripleHandler == null) { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/mime/src/main/java/org/apache/any23/mime/TikaMIMETypeDetector.java ---------------------------------------------------------------------- diff --git a/mime/src/main/java/org/apache/any23/mime/TikaMIMETypeDetector.java b/mime/src/main/java/org/apache/any23/mime/TikaMIMETypeDetector.java index 4596247..7cb23c0 100644 --- a/mime/src/main/java/org/apache/any23/mime/TikaMIMETypeDetector.java +++ b/mime/src/main/java/org/apache/any23/mime/TikaMIMETypeDetector.java @@ -83,7 +83,7 @@ public class TikaMIMETypeDetector implements MIMETypeDetector { * * @param is input stream to be verified. * @return <code>true</code> if <i>N3</i> patterns are detected, <code>false</code> otherwise. - * @throws IOException + * @throws IOException if there is an error checking the {@link java.io.InputStream} */ public static boolean checkN3Format(InputStream is) throws IOException { return findPattern(N3_PATTERNS, '.', is); @@ -94,7 +94,7 @@ public class TikaMIMETypeDetector implements MIMETypeDetector { * * @param is input stream to be verified. * @return <code>true</code> if <i>N3</i> patterns are detected, <code>false</code> otherwise. - * @throws IOException + * @throws IOException if there is an error checking the {@link java.io.InputStream} */ public static boolean checkNQuadsFormat(InputStream is) throws IOException { return findPattern(NQUADS_PATTERNS, '.', is); @@ -105,7 +105,7 @@ public class TikaMIMETypeDetector implements MIMETypeDetector { * * @param is input stream to be verified. * @return <code>true</code> if <i>Turtle</i> patterns are detected, <code>false</code> otherwise. - * @throws IOException + * @throws IOException if there is an error checking the {@link java.io.InputStream} */ public static boolean checkTurtleFormat(InputStream is) throws IOException { String sample = extractDataSample(is, '.'); @@ -127,7 +127,7 @@ public class TikaMIMETypeDetector implements MIMETypeDetector { * * @param is input stream to be verified. * @return <code>true</code> if <i>CSV</i> patterns are detected, <code>false</code> otherwise. - * @throws IOException + * @throws IOException if there is an error checking the {@link java.io.InputStream} */ public static boolean checkCSVFormat(InputStream is) throws IOException { return CSVReaderBuilder.isCSV(is); @@ -140,7 +140,8 @@ public class TikaMIMETypeDetector implements MIMETypeDetector { * @param delimiterChar the delimiter of the sample. * @param is the input stream to sample. * @return <code>true</code> if a pattern has been applied, <code>false</code> otherwise. - * @throws IOException + * @throws IOException if there is an error finding the pattern within + * the {@link java.io.InputStream} */ private static boolean findPattern(Pattern[] patterns, char delimiterChar, InputStream is) throws IOException { @@ -224,7 +225,7 @@ public class TikaMIMETypeDetector implements MIMETypeDetector { * The <i>input</i> stream must be resettable. * * @param fileName name of the data source. - * @param input <code>null</code> or a <b>resettable</i> input stream containing data. + * @param input <code>null</code> or a <i>resettable</i> input stream containing data. * @param mimeTypeFromMetadata mimetype declared in metadata. * @return the supposed mime type or <code>null</code> if nothing appropriate found. * @throws IllegalArgumentException if <i>input</i> is not <code>null</code> and is not resettable. http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/HTMLScraperExtractor.java ---------------------------------------------------------------------- diff --git a/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/HTMLScraperExtractor.java b/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/HTMLScraperExtractor.java index c6963da..0605f62 100644 --- a/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/HTMLScraperExtractor.java +++ b/plugins/html-scraper/src/main/java/org/apache/any23/plugin/htmlscraper/HTMLScraperExtractor.java @@ -40,9 +40,8 @@ import java.util.ArrayList; import java.util.List; /** - * Implementation of content extractor for performing <i>HTML<i/> scraping. + * Implementation of content extractor for performing <i>HTML</i> scraping. * - * @see HTMLScraperPlugin * @author Michele Mostarda ([email protected]) */ public class HTMLScraperExtractor implements Extractor.ContentExtractor { http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 617050f..e761507 100644 --- a/pom.xml +++ b/pom.xml @@ -231,8 +231,8 @@ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.resourceEncoding>UTF-8</project.build.resourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> - <javac.src.version>1.6</javac.src.version> - <javac.target.version>1.6</javac.target.version> + <javac.src.version>1.8</javac.src.version> + <javac.target.version>1.8</javac.target.version> <maven.build.timestamp.format>yyyy-MM-dd HH:mm:ssZ</maven.build.timestamp.format> <implementation.build>${scmBranch}@r${buildNumber}</implementation.build> <implementation.build.tstamp>${maven.build.timestamp}</implementation.build.tstamp> http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/service/src/main/java/org/apache/any23/servlet/conneg/ContentTypeNegotiator.java ---------------------------------------------------------------------- diff --git a/service/src/main/java/org/apache/any23/servlet/conneg/ContentTypeNegotiator.java b/service/src/main/java/org/apache/any23/servlet/conneg/ContentTypeNegotiator.java index 6f178c4..b74951f 100644 --- a/service/src/main/java/org/apache/any23/servlet/conneg/ContentTypeNegotiator.java +++ b/service/src/main/java/org/apache/any23/servlet/conneg/ContentTypeNegotiator.java @@ -41,7 +41,7 @@ public class ContentTypeNegotiator { * Returns the {@link MediaRangeSpec} * associated to the given <i>accept</i> type. * - * @param accept + * @param accept a provided <i>accept</i> type * @return a {@link MediaRangeSpec} associated to the accept parameter */ public MediaRangeSpec getBestMatch(String accept) { @@ -52,8 +52,8 @@ public class ContentTypeNegotiator { * Returns the {@link MediaRangeSpec} * associated to the given <i>accept</i> type and <i>userAgent</i>. * - * @param accept - * @param userAgent + * @param accept a provided <i>accept</i> type + * @param userAgent use agent associated with the request * @return the {@link MediaRangeSpec} * associated to the given <i>accept</i> type and <i>userAgent</i>. */ @@ -82,6 +82,7 @@ public class ContentTypeNegotiator { * Sets an Accept header to be used as the default if a client does * not send an Accept header, or if the Accept header cannot be parsed. * Defaults to "* / *". + * @param accept a default <i>accept</i> type */ protected void setDefaultAccept(String accept) { this.defaultAcceptRanges = MediaRangeSpec.parseAccept(accept); http://git-wip-us.apache.org/repos/asf/any23/blob/bb556858/service/src/main/java/org/apache/any23/servlet/conneg/MediaRangeSpec.java ---------------------------------------------------------------------- diff --git a/service/src/main/java/org/apache/any23/servlet/conneg/MediaRangeSpec.java b/service/src/main/java/org/apache/any23/servlet/conneg/MediaRangeSpec.java index 51f2bfb..db7b543 100644 --- a/service/src/main/java/org/apache/any23/servlet/conneg/MediaRangeSpec.java +++ b/service/src/main/java/org/apache/any23/servlet/conneg/MediaRangeSpec.java @@ -26,7 +26,6 @@ import java.util.regex.Pattern; /** * This class implements the <i>HTTP header media-range specification</i>. - * <br/> * See <a href="http://www.ietf.org/rfc/rfc2616.txt";>RFC 2616 section 14.1</a>. */ public class MediaRangeSpec { @@ -81,6 +80,8 @@ public class MediaRangeSpec { /** * Parses a media type from a string such as <tt>text/html;charset=utf-8;q=0.9</tt>. + * @param mediaType input string from which to extract mediaType + * @return {@link org.apache.any23.servlet.conneg.MediaRangeSpec} */ public static MediaRangeSpec parseType(String mediaType) { MediaRangeSpec m = parseRange(mediaType); @@ -93,6 +94,8 @@ public class MediaRangeSpec { /** * Parses a media range from a string such as <tt>text/*;charset=utf-8;q=0.9</tt>. * Unlike simple media types, media ranges may include wildcards. + * @param mediaRange input string from which to extract media range + * @return {@link org.apache.any23.servlet.conneg.MediaRangeSpec} */ public static MediaRangeSpec parseRange(String mediaRange) { Matcher m = mediaRangePattern.matcher(mediaRange); @@ -129,6 +132,7 @@ public class MediaRangeSpec { /** * Parses an HTTP Accept header into a List of MediaRangeSpecs * + * @param s an HTTP accept header. * @return A List of MediaRangeSpecs */ public static List<MediaRangeSpec> parseAccept(String s) {
