javatools.filehandlers

Class HTMLReader

java.lang.Object

java.io.Reader

javatools.filehandlers.HTMLReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public class HTMLReader
extends Reader

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The HTML-Reader reads characters from a HTML-file.
Example:

         HTMLReader r=new HTMLReader(new File("index.html"));
         int c;
         while((c=r.read())!=-1) {
           if(c==-2) System.out.print(" TAG:",r.getTag());
           else System.out.print(c);
         }
         
         -->
             This is the HTML-file, with resolved ampersand sequences
             and with -2 returned for tags.
   

If the file is UTF8-encoded, consider wrapping an UTF8Reader:

     HTMLReader r=new HTMLReader(new UTF8Reader(new File("index.html")));
   

Field Summary

Fields

Modifier and Type	Field and Description
protected long	announceChars number of chars for announce (or -1)
protected Reader	in Holds the actual reader
boolean	skipSTYLE TRUE to skip STYLE attributes
protected String	tag Holds the last tag (uppercased)
protected String	tagContent Holds the content of the last tag

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
HTMLReader(File f) Constructs a HTMLReader from a File
HTMLReader(File f, String message) Constructs a HTMLReader from a File with a progress bar
HTMLReader(Reader s) Constructs a HTMLReader from a Reader
HTMLReader(URL url) Constructs a HTMLReader for an URL

Method Summary

Modifier and Type	Method and Description
void	close()
String	getTag() Returns the last tag (uppercased)
String	getTagContent() Returns the content of the last tag
static void	main(String[] argv) Test routine
int	read() Reads a character, returns -2 for tags
int	read(char[] cbuf, int off, int len)
String	readTaggedText(String t) Seeks the next tag of name t and returns all text to the terminating tag /t.
String	readTextLine(int n) Reads a sequence of characters up to the blank following the nth char, ignores tags
boolean	scrollTo(String s) Seeks a specific string and scrolls to it, returns TRUE if found
boolean	scrollToTag(String s) Seeks a specific tag and scrolls to it, returns TRUE if found
StringBuilder	text(String forTag) Returns the entire text

Methods inherited from class java.io.Reader

mark, markSupported, read, read, ready, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

in

protected Reader in

Holds the actual reader

announceChars

protected long announceChars

number of chars for announce (or -1)

skipSTYLE

public boolean skipSTYLE

TRUE to skip STYLE attributes

tagContent

protected String tagContent

Holds the content of the last tag

tag

protected String tag

Holds the last tag (uppercased)

Constructor Detail

HTMLReader

public HTMLReader(Reader s)

Constructs a HTMLReader from a Reader

HTMLReader

public HTMLReader(URL url)
           throws IOException

Constructs a HTMLReader for an URL

Throws:

IOException

HTMLReader

public HTMLReader(File f)
           throws FileNotFoundException

Constructs a HTMLReader from a File

Throws:

FileNotFoundException

HTMLReader

public HTMLReader(File f,
                  String message)
           throws FileNotFoundException

Constructs a HTMLReader from a File with a progress bar

Throws:

FileNotFoundException

Method Detail

readTextLine

public String readTextLine(int n)
                    throws IOException

Reads a sequence of characters up to the blank following the nth char, ignores tags

Throws:

IOException

getTagContent

public String getTagContent()

Returns the content of the last tag

getTag

public String getTag()

Returns the last tag (uppercased)

read

public int read()
         throws IOException

Reads a character, returns -2 for tags

Overrides:

read in class Reader

Throws:

IOException

readTaggedText

public String readTaggedText(String t)
                      throws IOException

Seeks the next tag of name t and returns all text to the terminating tag /t. Nesting is not supported. Returns null if t was not found.

Throws:

IOException

text

public StringBuilder text(String forTag)
                   throws IOException

Returns the entire text

Throws:

IOException

scrollTo

public boolean scrollTo(String s)
                 throws IOException

Seeks a specific string and scrolls to it, returns TRUE if found

Throws:

IOException

scrollToTag

public boolean scrollToTag(String s)
                    throws IOException

Seeks a specific tag and scrolls to it, returns TRUE if found

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

main

public static void main(String[] argv)
                 throws Exception

Test routine

Throws:

Exception