Referenz: java.io.FilterReader

Weitere aktuelle Java-Titel finden Sie bei dpunkt.

Klasse java.io.FilterReader

1.1

java.lang.Object
   |
   +--java.io.Reader
         |
         +--java.io.FilterReader

Deklaration

public abstract class FilterReader extends java.io.Reader

Beschreibung

Diese Klasse ist das Reader-Äquivalent zum FilterInputStream und bietet eine Basis für Eingabe-Streams, die Unicode-Zeichen lesen und nach bestimmten Kriteriten filtern oder eine zusätzliche Funktionalität bieten. Ein FilterReader arbeitet grundsätzlich auf einem anderen Reader. Zur Implementierung der gewünschten Funtionalität müssen die read()-Methoden überschrieben werden, die standardmäßig die Aufrufe direkt an den angeschlossenen Reader weiterleiten.

Datenelemente
protected Reader	in

Konstruktoren
protected	FilterReader(Reader in)

Methoden
public void	close()
public void	mark(int readAheadLimit)
public boolean	markSupported()
public int	read()
public int	read(char[] b, int off, int len)
public boolean	ready()
public void	reset()
public long	skip(long n)

Datenelemente im Detail

protected Reader in
Der Stream, auf dem der FilterReader arbeitet.

Konstruktoren im Detail

protected FilterReader(Reader in)
Erzeugt einen neuen FilterReader für den Stream in.

Methoden im Detail

public void close()
Schließt den Stream.
Exception: IOException

public void mark(int readAheadLimit)
Markiert die momentane Position im Stream. Nachfolgende Aufrufe von reset() springen danach wieder an diese Position. Hierdurch ist es möglich, dieselben Bytes mehrfach zu lesen. Die Marke verfällt wieder, nach dem readAheadLimit Bytes aus dem Stream gelesen wurden, unabhängig davon, ob reset() aufgerufen wurde oder nicht.
Exception: IOException

public boolean markSupported()
Liefert true, wenn der Stream Markierung unterstützt, sonst false.

public int read()
Liest ein Zeichen und liefert es in der Unicode-Codierung zurück. Der Rückgabewert ist -1, falls das Ende des Streams erreicht ist.
Exception: IOException

public int read(char[] b, int off, int len)
Versucht, len Zeichen aus dem Stream zu lesen und speichert sie ab dem Index off in b. Wenn beim Versuch, das erste Zeichen zu lesen, das Dateiende bereits erreicht ist, ist der Rückgabewert -1. Ansonsten wird die Anzahl der tatsächlich gelesenen Bytes zurückgeliefert. Wenn während des Lesevorgangs das Stream-Ende erreicht wird oder wenn im darunterliegenden Stream nur weniger als len Bytes gelesen werden können, ohne zu blockieren, kehrt die Methode zurück und liefert die Anzahl der bis dahin gelesenen Bytes.
Exception: IOException

public boolean ready()
Liefert true, wenn Daten zum Lesen aus dem Stream bereitstehen, so dass ein nachfolgender Aufruf von read() nicht blockiert, sonst false.
Exception: IOException

public void reset()

Springt im Stream auf die Position zurück, die mit dem letzten Aufruf von mark() gesetzt wurde.

Exception: IOException

Falls ein Fehler auftritt.

public long skip(long n)
Versucht, n Bytes aus dem Stream zu überlesen, und liefert die Anzahl der tatsächlich übersrungenen Bytes. Diese kann kleiner als n sein, wenn vorzeitig das Ende des Streams erreicht wird. Fall momentan weniger als n Bytes im Stream bereitstehen, blockiert diese Methode so lange, bis n Bytes gelesen werden konnten oder das Stream-Ende erreicht ist.
Exception: IOException