<AxFile> Protocol Reference

#import <AxFile.h>

Inheritance diagram for <AxFile>:

Public Member Functions
(NSString *)	- getName
(NSString *)	- getPath
(NSObject< AxFile > *)	- getParent
(BOOL)	- isFile
(BOOL)	- isDirectory
(NSUInteger)	- getLength
(NSDate *)	- getCreated
(NSDate *)	- getModified
(BOOL)	- exists
(BOOL)	- canRead
(BOOL)	- canWrite
(NSData *)	- getContentsAsData
(void)	- setContentsWithData:
(NSString *)	- getContentsAsString
(void)	- setContentsWithString:
(NSString *)	- getContentsAsString:
(void)	- setContentsWithString:encoding:
(NSArray *)	- listFiles:
(id)	- getPeer
(BOOL)	- open:
(void)	- close
(BOOL)	- isEof
(void)	- seek:
(NSUInteger)	- getPosition
(NSData *)	- read:
(void)	- write:

---

Detailed Description

앱스프레소의 가상 파일.

Author:

iolo, sangchan

Version:

1.0

---

Member Function Documentation

- (BOOL) canRead

파일의 읽기 가능 여부를 반환.

Returns:

읽을 수 있으면 YES, 아니면 NO

- (BOOL) canWrite

파일의 쓰기 가능 여부를 반환.

Returns:

쓸 수 있으면 YES, 아니면 NO

- (void) close

파일을 닫음.

- (BOOL) exists

파일의 존재 여부를 반환.

Returns:

존재하면 YES, 아니면 NO

- (NSData*) getContentsAsData

바이트 배열 형식으로 파일의 내용을 읽음.

Returns:

내용 바이트 배열

- (NSString*) getContentsAsString

(UTF-8로 인코딩된)문자열 형식으로 파일의 내용을 읽음.

Returns:

내용 문자열

- (NSString*) getContentsAsString:

(NSString *)

encoding

지정된 인코딩을 가진 문자열 형식으로 파일의 내용을 읽음.

Parameters:

encoding

문자열 인코딩

Returns:

내용 문자열

- (NSDate*) getCreated

생성일자를 반환.

Returns:

NSDate 생성일

- (NSUInteger) getLength

파일의 크기(byte)를 반환.

Returns:

파일이면 파일 사이즈를 리턴함. 디렉토리이면 하위 파일 갯수를 리턴.

- (NSDate*) getModified

파일이 마지막으로 수정된 일자를 반환.

Returns:

NSDate 수정일

- (NSString*) getName

파일 이름을 반환

Returns:

파일 이름

- (NSObject<AxFile>*) getParent

부모 파일을 반환

Returns:

부모 파일의 인스턴스. 단, 파일이 root 이면 nil 을 반환.

- (NSString*) getPath

파일시스템의 이름으로 시작하는 가상 파일 경로를 반환

Returns:

파일의 가상 경로

- (id) getPeer

해당 파일 객체를 식별할 데이터를 반환.

Returns:

객체 식별용 고유값

- (NSUInteger) getPosition

파일포인터의 현재 위치를 반환.

Returns:

파일포인터의 현재 위치

- (BOOL) isDirectory

디렉토리인지 아닌지 식별함.

Returns:

디렉토리이면 YES, 아니면 NO

- (BOOL) isEof

파일포인터가 파일의 끝에 위치하고 있는지 확인.

Returns:

eof 일 경우 YES, 아닐 경우 NO.

- (BOOL) isFile

파일인지 아닌지 식별함.

Returns:

파일이면 YES, 아니면 NO

- (NSArray*) listFiles:

(NSObject< AxFileFilter > *)

filter

해당 조건을 만족하는 하위 파일의 목록을 리턴함.

Parameters:

filter

AxFileFilter 로 구현된 필터링 할 조건. nil일 경우 모든 파일을 가져옴.

Returns:

파일객체로 이루어진 NSArray

- (BOOL) open:

(int)

mode

읽고 쓰기 위한 상태로 파일을 연다.

Parameters:

mode	0=read,1=write,2=read/write

Returns:

열릴 경우 YES, 아닐 경우 NO.

- (NSData*) read:

(NSUInteger)

size

현재의 파일포인터의 위치부터 지정한 크기만큼 읽음. 앞으로 읽을 수 있는 크기가 지정한 크기보다 작을 경우 가능한 크기 만큼만 읽는다.

Parameters:

size

읽어 올 크기

Returns:

읽어온 데이터

- (void) seek:

(NSUInteger)

position

지정한 위치로 파일포인터를 이동.

Parameters:

position

파일포인터를 이동시킬 위치

- (void) setContentsWithData:

(NSData *)

data

바이트 배열 형식으로 파일의 내용을 변경.

Parameters:

data

내용

- (void) setContentsWithString:

(NSString *)

str

(UTF-8로 인코딩된)문자열 형식으로 파일의 내용을 변경.

Parameters:

str

내용

- (void) setContentsWithString:		(NSString *)	str
encoding:		(NSString *)	encoding

지정된 인코딩을 가진 문자열 형식으로 파일의 내용을 변경.

Parameters:

str	내용
encoding	문자열 인코딩

- (void) write:

(NSData *)

data

현재 파일포인터의 위치부터 데이터를 쓴다.

Parameters:

data	쓰고자 하는 데이터