java.beans
클래스 XMLEncoder

java.lang.Object 
  |
  +--java.beans.Encoder 
        |
        +--java.beans.XMLEncoder

public class XMLEncoder

extends Encoder

XMLEncoder 클래스는 ObjectOutputStream 의 보완적인 대체 클래스이며,ObjectOutputStream 로 Serializable 오브젝트의 바이너리 표현을 생성하는 경우와 같게 해 JavaBean 의 텍스트 표현을 생성합니다. 예를 들어, 다음의 코드에서는 제공된 JavaBean 와 그 모든 프로퍼티의 텍스트 표현을 생성할 수 있습니다.

       XMLEncoder e = new XMLEncoder(
                          new BufferedOutputStream(
                              new FileOutputStream("Test.xml")));
       e.writeObject(new JButton("Hello, world"));
       e.close();
 

API 는 비슷하지만,XMLEncoder 클래스는 JavaBean 의 그래프를 그 공개 프로퍼티의 텍스트 표현으로서 어카이브(archive)화하는 목적으로 설계되고 있습니다. 이 방식에서 작성된 문서는 Java 원시 파일과 같이, 필요한 클래스의 구현이 변경으로부터 보호되고 있습니다. 프로세스간 통신 및 통상 목적의 직렬화에는 지금까지 대로 ObjectOutputStream 를 사용하는 것을 추천합니다.

XMLEncoder 클래스는 JavaBean 를, XML 사양 버젼 1.0 으로 Unicode/ISO 10646 캐릭터 세트의 UTF-8 캐릭터 인코딩에 준거한 XML 문서로서 표현하는 디폴트의 지정을 제공합니다. XMLEncoder 클래스에 의해 생성되는 XML 문서에는 다음과 같은 특징이 있습니다.

• 이식성과 버젼의 차이에 대한 허용성: 클래스의 비공개 구현에는 일절 의존하지 않기 때문에, Java 원시 파일과 같게, 일부의 클래스의 버젼이 다른 복수의 환경간, 혹은 벤더가 다른 VM 간에 교환 가능
• 컴팩트한 구조: XMLEncoder 클래스는 내부에서 장황성 삭감 알고리즘을 사용하기 위해(때문에), Bean 의 프로퍼티의 디폴트 값가 스트림에 기입해지지 않다
• 장해 허용성: 파일이 망가지거나 로컬라이즈 된 어카이브(archive)내의 클래스의 API 가 변경 되거나 해, 파일내에 비구조상의 에러가 생겨도, 에러를 보고해, 문서내의 에러의 영향을 받고 있지 않은 부분을 계속 로드할 수가 있다

이하는 swing 툴 킷의 유저 인터페이스 컴퍼넌트를 포함한 XML 어카이브(archive)의 예입니다.

 <? xml version="1.0" encoding="UTF-8"? >
 <java version="1.0" class="java.beans.XMLDecoder">
 <object class="javax.swing.JFrame">
   <void property="name">
     <string>frame1</string>
   </void>
   <void property="bounds">
     <object class="java.awt.Rectangle">
       <int>0</int>
       <int>0</int>
       <int>200</int>
       <int>200</int>
     </object>
   </void>
   <void property="contentPane">
     <void method="add">
       <object class="javax.swing.JButton">
         <void property="label">
           <string>Hello</string>
         </void>
       </object>
     </void>
   </void>
   <void property="visible">
     <boolean>true</boolean>
   </void>
 </object>
 </java>
 

XML 구문은 다음의 규약에 준거하고 있습니다.

• 개개의 요소는 메소드 호출을 나타낸다
• object 태그는 둘러싸는 요소의 인수로서 사용되는 값을 가지는 식을 나타낸다
• void 태그는 실행되는 것만으로, 그 결과는 둘러싸는 메소드의 인수로서 사용되지 않는 문장을 나타낸다
• 다른 요소를 포함 하는 요소는 이러한 요소를 인수로서 사용한다. 다만, 포함 되고 있는 요소에 void 태그가 포함되지 않은 경우에 한한다
• 메소드명은 method 속성에 의해 나타내진다
• XML 의 표준 속성인 id 및 idref 를 사용해 이전의 식을 참조해, 오브젝트 그래프의 순환을 처리한다
• class 속성을 사용해 정적 메소드 또는 constructor 의 타겟을 명시적으로 지정한다. 그 값은 완전 지정의 클래스명이 된다
• void 태그 첨부의 요소는 class 속성에 의해 타겟이 정의되어 있지 않은 경우, 외부 문맥을 타겟으로서 실행된다
• Java 의 String 클래스는 특별한 것으로 해, <string>Hello, world</string> 에 기입해진다. 여기서, 캐릭터 라인에 포함되는 캐릭터는 UTF-8 캐릭터 인코딩에 의해 바이트에 변환된다

모든 오브젝트 그래프는 이것들 3 개의 태그로 기술할 수 있습니다만, 공통의 데이터 구조를 보다 간결하게 표현하기 위해(때문에), 다음의 정의가 이루어지고 있습니다.

• 디폴트의 메소드명은 new
• java 클래스의 참조는 <class>javax.swing.JButton</class> 라고 하는 형식에서 기술한다
• Java 원시적형의 래퍼 클래스의 인스턴스는 원시적형의 이름을 태그로서 기술된다. 예를 들어,Integer 클래스의 인스턴스는 <int>123</int> 와 기술할 수 있다. XMLEncoder 클래스가, Java 원시적형과 관련 래퍼 클래스간의 변환을 내부적으로 처리하는 Java 리플렉션 패키지를 사용하는 점에 주의하는 것. XMLEncoder 클래스의 API 자체는 Object 만을 취급한다
• 이름의 선두의 캐릭터 라인이 get 로 시작되는 것 같은 nullary 의 메소드를 표현하는 요소에서는 method 속성은 property 속성으로 옮겨놓을 수 있다. 덧붙여 property 속성의 값은 get 접두사를 삭제해, 메소드명의 선두의 캐릭터를 알파벳의 소문자로 변경하는 것에 의해 얻을 수 있다
• 이름의 선두의 캐릭터 라인이 set 로 시작되는 것 같은 단일의 메소드를 표현하는 요소에서는 method 속성은 property 속성으로 옮겨놓을 수 있다. 덧붙여 property 속성의 값은 set 접두사를 삭제해, 메소드명의 선두의 캐릭터를 알파벳의 소문자로 변경하는 것에 의해 얻을 수 있다
• get 메소드로서 지정되어 정수의 인수를 1 개 취하는 것 같은 메소드를 표현하는 요소에서는 method 속성은 index 속성으로 옮겨놓을 수 있다. 덧붙여 index 속성의 값은 최초의 인수의 값과 같게 된다
• set 메소드로서 지정되어 인수를 2 개 취하는 것 같은 메소드를 표현하는 요소에서는 method 속성은 index 속성으로 옮겨놓을 수 있다. 덧붙여 index 속성의 값은 최초의 인수의 값과 같게 된다
• 배열의 참조는 array 태그에 의해 기술된다. class 속성은 그 배열의 아류형, length 속성은 그 배열의 길이를 지정한다

도입된 버젼:

1.4

관련 항목:

XMLDecoder , ObjectOutputStream

생성자의 개요

XMLEncoder (OutputStream out)
XML 인코딩을 사용해 스트림 out 에 JavaBeans 를 송신하는 새로운 출력 스트림을 작성합니다.

메소드의 개요

void	close () 이 메소드는 flush 를 호출해, 닫는 postamble를 기입해, 이 스트림에 관련지을 수 있고 있는 출력 스트림을 클로우즈 합니다.
void	flush () 이 메소드는 XML 인코딩에 관련지을 수 있었던 프리안불을 써내,flush 를 마지막으로 호출했을 때로부터 스트림에 기입해진 모든 값을 써냅니다.
Object	getOwner () 이 엔코더의 소유자를 취득합니다.
void	setOwner (Object owner) 이 엔코더의 소유자를 owner 로 설정합니다.
void	writeExpression (Expression oldExp) 이 메소드는 슈퍼 클래스의 구현을 호출해,oldExp 를 기록하는 것으로써, 스트림의 플래시시에 실제의 출력을 생성합니다.
void	writeObject (Object o) 지정된 오브젝트의 XML 표현을 출력에 기입합니다.
void	writeStatement (Statement oldStm) 이 메소드는 슈퍼 클래스의 구현을 호출해,oldStm 를 기록하는 것으로써, 스트림의 플래시시에 실제의 출력을 생성합니다.

클래스 java.beans. Encoder 에서 상속받은 메소드

get , getExceptionListener , getPersistenceDelegate , remove , setExceptionListener , setPersistenceDelegate

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

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

생성자의 상세

XMLEncoder

public XMLEncoder(OutputStream  out)

XML 인코딩을 사용해 스트림 out 에 JavaBeans 를 송신하는 새로운 출력 스트림을 작성합니다.

파라미터:

out - 오브젝트의 XML 표현의 송신지가 되는 스트림

관련 항목:

XMLDecoder.XMLDecoder(InputStream)

메소드의 상세

setOwner

public void setOwner(Object  owner)

이 엔코더의 소유자를 owner 로 설정합니다.

파라미터:

owner - 이 엔코더의 소유자

관련 항목:

getOwner()

getOwner

public Object  getOwner()

이 엔코더의 소유자를 취득합니다.

반환값:

이 엔코더의 소유자

관련 항목:

setOwner(java.lang.Object)

writeObject

public void writeObject(Object  o)

지정된 오브젝트의 XML 표현을 출력에 기입합니다.

오버라이드(override):

클래스 Encoder 내의 writeObject

파라미터:

o - 스트림에 기입해지는 오브젝트

관련 항목:

XMLDecoder.readObject()

writeStatement

public void writeStatement(Statement  oldStm)

이 메소드는 슈퍼 클래스의 구현을 호출해,oldStm 를 기록하는 것으로써, 스트림의 플래시시에 실제의 출력을 생성합니다.

오버라이드(override):

클래스 Encoder 내의 writeStatement

파라미터:

oldStm - 스트림에 기입해지는 문장

writeExpression

public void writeExpression(Expression  oldExp)

이 메소드는 슈퍼 클래스의 구현을 호출해,oldExp 를 기록하는 것으로써, 스트림의 플래시시에 실제의 출력을 생성합니다.

오버라이드(override):

클래스 Encoder 내의 writeExpression

파라미터:

oldExp - 스트림에 기입해지는 식

flush

public void flush()

이 메소드는 XML 인코딩에 관련지을 수 있었던 프리안불을 써내,flush 를 마지막으로 호출했을 때로부터 스트림에 기입해진 모든 값을 써냅니다. 플래시 후, 이 스트림에 기입해진 값의 내부 참조는 모두 클리어 됩니다.

close

public void close()

이 메소드는 flush 를 호출해, 닫는 postamble를 기입해, 이 스트림에 관련지을 수 있고 있는 출력 스트림을 클로우즈 합니다.