javax.xml.stream
인터페이스 XMLEventWriter

모든 슈퍼 인터페이스:

XMLEventConsumer

public interface XMLEventWriter
extends XMLEventConsumer 

XML 문서를 기입하기 위한 최상정도의 인터페이스입니다. 이 인터페이스의 인스턴스가, XML 의 형식을 검증할 필요는 없습니다.

도입된 버젼:

1.6

관련 항목:

XMLEventReader , XMLEvent , Characters , ProcessingInstruction , StartElement , EndElement

메소드의 개요

void	add (XMLEvent event) 출력 스트림에 이벤트를 추가합니다.
void	add (XMLEventReader reader) 스트림 전체를 출력 스트림에 추가해, hasNext()가 false 를 돌려줄 때까지 inputStream 인수로 next()를 호출합니다.
void	close () 이 스트림에 관련지을 수 있었던 자원을 모두 해제합니다.
void	flush () 캐쉬에 포함된 모든 이벤트를, 기본이 되는 출력 기구에 기입합니다.
NamespaceContext	getNamespaceContext () 현재의 이름 공간 문맥을 돌려줍니다.
String	getPrefix (String uri) URI 의 바인드처의 접두사를 가져옵니다.
void	setDefaultNamespace (String uri) URI 를 디폴트의 이름 공간에 바인드 합니다.
void	setNamespaceContext (NamespaceContext context) 접두사와 URI 의 바인드에 대해서, 현재의 이름 공간 문맥을 설정합니다.
void	setPrefix (String prefix, String uri) URI 의 바인드처의 접두사를 설정합니다.

메소드의 상세

flush

void flush()
           throws XMLStreamException 

캐쉬에 포함된 모든 이벤트를, 기본이 되는 출력 기구에 기입합니다.

예외:

XMLStreamException

close

void close()
           throws XMLStreamException 

이 스트림에 관련지을 수 있었던 자원을 모두 해제합니다.

예외:

XMLStreamException

add

void add(XMLEvent  event)
         throws XMLStreamException 

출력 스트림에 이벤트를 추가합니다. START_ELEMENT 를 추가하면(자), 새로운 이름 공간의 스코프가 열립니다. 이것은, 대응하는 END_ELEMENT 가 기입해진다고 닫습니다.

라이터에 추가되는 이벤트의 필수 필드와 옵션필드
이벤트형	필수 필드	옵션필드	필수의 동작
START_ELEMENT	QName name	이름 공간, 속성	START_ELEMENT 의 기입에서는, 이벤트의 이름, 이름 공간, 및 속성이 XML 1.0 의 유효한 START_ELEMENT 의 구문으로 기입해집니다. 이름은, 이름 공간 URI 의 접두사를 검색해 기입해집니다. 라이터는, QName 의 접두사에 관계 붙이도록(듯이) 설정할 수 있습니다. 라이터를 접두사에 관계 붙이는 경우는, QName 로 접두사 세트를 사용할 필요가 있습니다. 디폴트의 동작에서는, EventWriter 의 내부 이름 공간 문맥으로 접두사의 값이 검색됩니다. 속성이 존재하는 경우, 각 속성은 이 표의 속성의 섹션으로 지정된 동작을 사용해 기입해집니다. 이름 공간이 존재하는 경우, 각 이름 공간은 이 표의 이름 공간의 섹션으로 지정된 동작을 사용해 기입해집니다.
END_ELEMENT	Qname name	없음	정형식의 END_ELEMENT 태그가 기입해집니다. 이름은, 이름 공간 URI 의 접두사를 검색해 기입해집니다. 라이터는, QName 의 접두사에 관계 붙이도록(듯이) 설정할 수 있습니다. 라이터를 접두사에 관계 붙이는 경우는, QName 로 접두사 세트를 사용할 필요가 있습니다. 디폴트의 동작에서는, EventWriter 의 내부 이름 공간 문맥으로 접두사의 값이 검색됩니다. END_ELEMENT 의 이름이 START_ELEMENT 의 이름에 일치하지 않는 경우, XMLStreamException 가 throw 됩니다.
ATTRIBUTE	QName name, String value	QName type	START_ELEMENT 로 사용되는 것과 같은 자구 형식 검색 알고리즘을 사용해, 속성이 기입해집니다. 디폴트에서는, 속성치를 둘러싸기 위해서(때문에) 이중 인용부호가 사용되어 치내에 있는 이중 인용부호를 모두 이스케이프 합니다. 형태의 값은 무시됩니다.
NAMESPACE	String prefix, String namespaceURI, boolean isDefaultNamespaceDeclaration	없음	이름 공간 선언이 기입해집니다. 이름 공간이 디폴트의 이름 공간 선언 (isDefaultNamespaceDeclaration 가 true)인 경우, xmlns="$namespaceURI" 가 기입해져 접두사는 옵션입니다. isDefaultNamespaceDeclaration 가 false 인 경우, 접두사를 선언할 필요가 있어, 라이터는 xmlns 를 접두사의 전에 부가해, 표준의 접두사 선언을 써낼 필요가 있습니다.
PROCESSING_INSTRUCTION	없음	String target, String data	데이터가 존재할 필요는 없고, null 에서도 괜찮습니다. 타겟은 필수로, null 이외입니다. 라이터는 적절한 XML 1.0 구문에 따라, 타겟의 직후에 데이터 섹션을 기입합니다.
COMMENT	없음	String comment	코멘트가 존재하는 경우 (null 이외), 그 코멘트가 기입해집니다. 존재하지 않는 경우는, 빈 상태(empty)의 코멘트가 기입해집니다.
START_DOCUMENT	없음	String encoding, boolean standalone, String version	START_DOCUMENT 이벤트를 스트림에 기입할 필요는 없습니다. 속성이 존재하는 경우, 그러한 속성은 적절한 XML 선언의 구문으로 기입해집니다.
END_DOCUMENT	없음	없음	아무것도 출력에 기입해지지 않습니다.
DTD	String DocumentTypeDefinition	없음	DocumentTypeDefinition 가 출력에 기입해집니다.

정의:

인터페이스 XMLEventConsumer 내의 add

파라미터:

event - 추가되는 이벤트

예외:

XMLStreamException

add

void add(XMLEventReader  reader)
         throws XMLStreamException 

스트림 전체를 출력 스트림에 추가해, hasNext()가 false 를 돌려줄 때까지 inputStream 인수로 next()를 호출합니다. 이것은, 이벤트 리더내의 모든 이벤트에 대한 후속의 루프를 실행해, 각 이벤트로 add 를 호출하기 위한 편리한 방법으로서 사용하도록(듯이) 합니다.

파라미터:

reader - 출력에 추가하는 이벤트 스트림

예외:

XMLStreamException

getPrefix

String  getPrefix(String  uri)
                 throws XMLStreamException 

URI 의 바인드처의 접두사를 가져옵니다.

파라미터:

uri - 검색하는 URI

예외:

XMLStreamException

setPrefix

void setPrefix(String  prefix,
               String  uri)
               throws XMLStreamException 

URI 의 바인드처의 접두사를 설정합니다. 이 접두사는, 현재의 START_ELEMENT 와 END_ELEMENT 의 페어의 범위에 바인드 됩니다. START_ELEMENT 가 기입해지기 전에 이 메소드가 불려 가면(자), 접두사는 루트의 범위에 바인드 됩니다.

파라미터:

prefix - URI 에 바인드 되는 접두사

uri - 접두사에 바인드 되는 URI

예외:

XMLStreamException

setDefaultNamespace

void setDefaultNamespace(String  uri)
                         throws XMLStreamException 

URI 를 디폴트의 이름 공간에 바인드 합니다. 이 URI 는, 현재의 START_ELEMENT 와 END_ELEMENT 의 페어의 범위에 바인드 됩니다. START_ELEMENT 가 기입해지기 전에 이 메소드가 불려 가면(자), URI 는 루트의 범위에 바인드 됩니다.

파라미터:

uri - 디폴트의 이름 공간에 바인드 되는 URI

예외:

XMLStreamException

setNamespaceContext

void setNamespaceContext(NamespaceContext  context)
                         throws XMLStreamException 

접두사와 URI 의 바인드에 대해서, 현재의 이름 공간 문맥을 설정합니다. 이 문맥은 기입해에 사용하는 루트의 이름 공간 문맥이 됩니다. 또, 현재의 루트의 이름 공간 문맥을 옮겨놓습니다. 후속의 setPrefix 및 setDefaultNamespace 의 호출에서는, 이름 공간의 해결용으로 루트 문맥으로서 메소드에게 건네진 문맥을 사용해 이름 공간이 바인드 됩니다.

파라미터:

context - 이 라이터에 사용하는 이름 공간 문맥

예외:

XMLStreamException

getNamespaceContext

NamespaceContext  getNamespaceContext()

현재의 이름 공간 문맥을 돌려줍니다.

반환값:

현재의 이름 공간 문맥