java.io
클래스 Reader

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

직계의 기존의 서브 클래스:

BufferedReader , CharArrayReader , FilterReader , InputStreamReader , PipedReader , StringReader

public abstract class Reader

extends Object

캐릭터 스트림을 읽어들이기 위한 추상 클래스입니다. 서브 클래스에서 구현할 필요가 있는 메소드는 read(char[], int, int)와 close() 뿐입니다. 다만, 대부분의 서브 클래스에서는 효율을 자주(잘) 하든가 또는 기능을 추가하는 (또는 그 양쪽 모두) 위해(때문에), 여기서 정의하는 메소드의 일부를 오버라이드(override) 합니다.

도입된 버젼:

JDK1. 1

관련 항목:

BufferedReader , LineNumberReader , CharArrayReader , InputStreamReader , FileReader , FilterReader , PushbackReader , PipedReader , StringReader , Writer

필드의 개요

protected Object

lock 이 스트림으로 조작을 동기 시키는데 사용하는 오브젝트입니다.

생성자의 개요

protected	Reader () 그 위기인 섹션이 리더 자체로 동기 하는 새로운 캐릭터 스트림 리더를 작성합니다.
protected	Reader (Object lock) 그 위기인 섹션이 지정된 오브젝트로 동기 하는 새로운 캐릭터 스트림 리더를 작성합니다.

메소드의 개요

abstract void	close () 스트림을 닫습니다.
void	mark (int readAheadLimit) 스트림의 현재의 위치에 마크를 설정합니다.
boolean	markSupported () 이 스트림이 mark() 오퍼레이션을 서포트할지 어떨지를 판정합니다.
int	read () 단일 캐릭터를 읽어들입니다.
int	read (char[] cbuf) 배열에 캐릭터를 읽어들입니다.
abstract int	read (char[] cbuf, int off, int len) 배열의 일부에 캐릭터를 읽어들입니다.
boolean	ready () 이 스트림이 읽어들여 가능한가 어떤가를 판정합니다.
void	reset () 스트림을 리셋트 합니다.
long	skip (long n) 캐릭터를 스킵 합니다.

클래스 java.lang. Object 에서 상속받은 메소드

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

필드의 상세

lock

protected Object  lock

이 스트림으로 조작을 동기 시키는데 사용하는 오브젝트입니다. 효율을 자주(잘) 하기 위한(해), 캐릭터 스트림 오브젝트에서는 다른 오브젝트를 사용해 위기 섹션을 보호할 수가 있습니다. 그 때문에, 서브 클래스에서는 this 나 동기 메소드는 아니고, 이 필드의 오브젝트를 사용합니다.

생성자의 상세

Reader

protected Reader()

그 위기인 섹션이 리더 자체로 동기 하는 새로운 캐릭터 스트림 리더를 작성합니다.

Reader

protected Reader(Object  lock)

그 위기인 섹션이 지정된 오브젝트로 동기 하는 새로운 캐릭터 스트림 리더를 작성합니다.

파라미터:

lock - 동기 하는 오브젝트

메소드의 상세

read

public int read()
         throws IOException 

단일 캐릭터를 읽어들입니다. 이 메소드는 캐릭터가 읽히는지 입출력 에러가 발생하든가, 혹은 스트림의 마지막에 이를 때까지 블록 합니다.

유효한 단일 캐릭터의 입력을 서포트하기 위한 서브 클래스에서는 이 메소드를 오버라이드(override) 합니다.

반환값:

0 ~ 65535 (0x00-0xffff)의 범위의 정수로서의, 읽힌 캐릭터. 스트림의 마지막에 이르렀을 경우는 -1

예외:

IOException - 입출력 에러가 발생했을 경우

read

public int read(char[] cbuf)
         throws IOException 

배열에 캐릭터를 읽어들입니다. 이 메소드는 캐릭터가 읽히는지 입출력 에러가 발생하든가, 혹은 스트림의 마지막에 이를 때까지 블록 합니다.

파라미터:

cbuf - 전송처 버퍼

반환값:

읽힌 캐릭터수. 스트림의 마지막에 이르렀을 경우는 -1

예외:

IOException - 입출력 에러가 발생했을 경우

read

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

배열의 일부에 캐릭터를 읽어들입니다. 이 메소드는 캐릭터가 읽히는지 입출력 에러가 발생하든가, 혹은 스트림의 마지막에 이를 때까지 블록 합니다.

파라미터:

cbuf - 전송처 버퍼

off - 캐릭터의 저장 개시 오프셋(offset)

len - 읽어들이는 캐릭터의 최대수

반환값:

읽힌 캐릭터수. 스트림의 마지막에 이르렀을 경우는 -1

예외:

IOException - 입출력 에러가 발생했을 경우

skip

public long skip(long n)
          throws IOException 

캐릭터를 스킵 합니다. 이 메소드는 캐릭터가 읽히는지 입출력 에러가 발생하든가, 혹은 스트림의 마지막에 이를 때까지 블록 합니다.

파라미터:

n - 스킵 하는 캐릭터수

반환값:

실제로 스킵 한 캐릭터수

예외:

IllegalArgumentException - n 가 부의 값의 경우

IOException - 입출력 에러가 발생했을 경우

ready

public boolean ready()
              throws IOException 

이 스트림이 읽어들여 가능한가 어떤가를 판정합니다.

반환값:

다음의 read()가 입력을 블록 하지 않는 것이 확실한 경우는 true, 그렇지 않은 경우는 false. false 가 돌려주어져도, 다음의 read가 확실히 블록 한다는 것이 아니다

예외:

IOException - 입출력 에러가 발생했을 경우

markSupported

public boolean markSupported()

이 스트림이 mark() 오퍼레이션을 서포트할지 어떨지를 판정합니다. 디폴트 구현은 항상 false 를 돌려줍니다. 서브 클래스는 이 메소드를 오버라이드(override) 합니다.

반환값:

이 스트림이 mark 오퍼레이션을 서포트하는 경우에 한정해 true

mark

public void mark(int readAheadLimit)
          throws IOException 

스트림의 현재의 위치에 마크를 설정합니다. 이후의 reset()의 호출에서는 스트림을 이 정도치에 배치하려고 합니다. 모든 캐릭터 입력 스트림으로 mark() 오퍼레이션이 서포트되고 있는 것은 아닙니다.

파라미터:

readAheadLimit - 마크를 보관 유지하면서 읽어들일 수가 있는 캐릭터수의 상한. 이 수의 캐릭터를 읽어들인 후에 스트림을 리셋트 하려고 하면(자) 실패하는 경우가 있다

예외:

IOException - 스트림이 mark()를 서포트하지 않는 경우, 또는 그 외의 입출력 에러가 발생했을 경우

reset

public void reset()
           throws IOException 

스트림을 리셋트 합니다. 스트림에 마크가 설정되어 있으면(자), 그 마크에 재배치하려고 합니다. 마크가 설정되어 있지 않으면, 개시 위치에 재배치하는 등의, 개개의 스트림에 적절했군 등이나 방법으로 리셋트를 시도합니다. 모든 캐릭터 입력 스트림으로 reset() 오퍼레이션이 서포트되고 있는 것은 아닙니다. 또, mark()를 서포트하지 않고 reset()를 서포트하는 것도 있습니다.

예외:

IOException - 스트림에 마크가 설정되지 않았던 경우, 또는 마크의 설정이 무효가 되었을 경우, 또는 스트림이 reset()를 서포트하지 않는 경우, 또는 다른 입출력 에러가 발생했을 경우

close

public abstract void close()
                    throws IOException 

스트림을 닫습니다. 스트림을 한 번 닫아 이후 read(), ready(), mark(), 또는 reset()를 호출하면(자), IOException 가 슬로우 됩니다. 다만, 전에 닫은 스트림을 닫아도 효과는 없습니다.

예외:

IOException - 입출력 에러가 발생했을 경우