|
JavaTM Platform Standard Ed. 6 |
|||||||||
| 앞의 클래스 다음의 클래스 | 프레임 있어 프레임 없음 | |||||||||
| 개요 : 상자 | 필드 | 생성자 | 메소드 | 상세: 필드 | 생성자 | 메소드 | |||||||||
public interface Unmarshaller
Unmarshaller 클래스는, XML 데이터를 신규 작성 Java 컨텐츠 트리에 직렬화 복원해, 옵션으로서 비정렬화시에 XML 데이터를 검증하는 프로세스를 제어합니다. 다수가 다른 종류의 입력에 대한 비정렬화 메소드의 overload를 제공합니다.
파일로부터 비정렬화합니다.
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
Object o = u.unmarshal( new File( "nosferatu.xml" ) );
InputStream 로부터 비정렬화합니다.
InputStream is = new FileInputStream( "nosferatu.xml" );
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
Object o = u.unmarshal( is );
URL 로부터 비정렬화합니다.
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
URL url = new URL( "http://beaker.east/nosferatu.xml" );
Object o = u.unmarshal( url );
javax.xml.transform.stream.StreamSource 를 사용해 StringBuffer 로부터 비정렬화합니다.
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
StringBuffer xmlStr = new StringBuffer( "<? xml version="1. 0"? >..." );
Object o = u.unmarshal( new StreamSource( new StringReader( xmlStr.toString() ) ) );
org.w3c.dom.Node 로부터 비정렬화합니다.
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
DocumentBuilder db = dbf.newDocumentBuilder();
Document doc = db.parse(new File( "nosferatu.xml"));
Object o = u.unmarshal( doc );
클라이언트가 지정한 검증 SAX2. 0 퍼서를 사용해 javax.xml.transform.sax.SAXSource 로부터 비정렬화합니다.
// configure a validating SAX2. 0 parser (Xerces2)
static final String JAXP_SCHEMA_LANGUAGE =
"http://java.sun.com/xml/jaxp/properties/schemaLanguage";
static final String JAXP_SCHEMA_LOCATION =
"http://java.sun.com/xml/jaxp/properties/schemaSource";
static final String W3C_XML_SCHEMA =
"http://www.w3.org/2001/XMLSchema";
System.setProperty( "javax.xml.parsers.SAXParserFactory",
"org.apache.xerces.jaxp.SAXParserFactoryImpl" );
SAXParserFactory spf = SAXParserFactory.newInstance();
spf.setNamespaceAware(true);
spf.setValidating(true);
SAXParser saxParser = spf.newSAXParser();
try {
saxParser.setProperty(JAXP_SCHEMA_LANGUAGE, W3C_XML_SCHEMA);
saxParser.setProperty(JAXP_SCHEMA_LOCATION, "http://....");
} catch (SAXNotRecognizedException x) {
// exception handling omitted
}
XMLReader xmlReader = saxParser.getXMLReader();
SAXSource source =
new SAXSource( xmlReader, new InputSource( "http://..." ) );
// Setup JAXB to unmarshal
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
ValidationEventCollector vec = new ValidationEventCollector();
u.setEventHandler( vec );
// turn off the JAXB provider's default validation mechanism to
// avoid duplicate validation
u.setValidating( false )
// unmarshal
Object o = u.unmarshal( source );
// check for events
if( vec.hasEvents() ) {
// iterate over events
}
StAX XMLStreamReader 로부터 비정렬화합니다.
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
javax.xml.stream.XMLStreamReader xmlStreamReader =
javax.xml.stream.XMLInputFactory(). newInstance(). createXMLStreamReader( ... );
Object o = u.unmarshal( xmlStreamReader );
StAX XMLEventReader 로부터 비정렬화합니다.
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
javax.xml.stream.XMLEventReader xmlEventReader =
javax.xml.stream.XMLInputFactory(). newInstance(). createXMLEventReader( ... );
Object o = u.unmarshal( xmlEventReader );
비정렬화에서는, XML 문서 전체 또는 XML 문서의 서브 트리를 나타내는 XML 데이터를 직렬화 복원할 수 있습니다. 일반적으로은, 「글로벌하게 선언된 루트 요소의 비정렬화」로 설명되고 있는 비정렬화 메소드를 사용하면 충분합니다. 이러한 비정렬화 메소드는, 글로벌 XML 요소 선언 및 형태 선언으로부터 JAXB 맵 클래스에의JAXBContext의 매핑을 이용해, XML 데이터의 루트 요소의 비정렬화 처리를 초기화합니다.JAXBContext의 매핑이 XML 데이터의 루트 요소를 비정렬화하는데 불충분한 경우, 어플리케이션은 declaredType 에 의한 비정렬화 메소드를 사용해 비정렬화 프로세스를 지원할 수가 있습니다. 이러한 메소드는, 루트 요소가 schema의 로컬 요소 선언에 대응하는 XML 데이터를 비정렬화할 때 도움이 됩니다.
비정렬화 메소드는 null 를 돌려주지 않습니다. 비정렬화 프로세스가 XML 컨텐츠의 루트를 JAXB 맵 객체의 루트에 비정렬화할 수 없는 경우, JAXBException 를 throw 하는 것에 의해 치명적인 에러가 보고되어 처리가 중지됩니다.
declaredType 파라미터를 포함하지 않는 비정렬화 메소드는,JAXBContext를 사용해 XML 데이터의 루트 요소를 비정렬화합니다.JAXBContext인스턴스는, 이 Unmarshaller 의 작성에 사용된 인스턴스입니다.JAXBContext인스턴스는, 글로벌하게 선언된 XML 요소 및 형태 정의명으로부터 JAXB 맵 클래스에의 매핑을 보관 유지하고 있습니다. 비정렬화 메소드는, 루트 요소의 XML 명 또는 @xsi:type, 혹은 그 양쪽 모두로부터 JAXB 맵 클래스에의 매핑이JAXBContext에 포함될지 어떨지를 체크합니다. 이것을 포함한 경우, 적절한 JAXB 맵 클래스를 사용해 XML 데이터를 비정렬화합니다. 루트 요소명이 불명해, 루트 요소에 @xsi:type 가 포함되는 경우,JAXBElement의 값으로 해서 JAXB 맵 클래스를 사용해 XML 데이터는 비정렬화 됩니다.JAXBContext객체에, 루트 요소의 이름 또는 그 @xsi:type (이것이 존재하는 경우)에 대한 매핑이 포함되지 않는 경우, 비정렬화 조작은UnmarshalException를 throw 하는 것에 의해 즉시 강제 종료됩니다. 다음의 서브 섹션으로 설명하는 declaredType 에 의한 비정렬화를 사용하는 것에 의해, 이 예외 시나리오를 회피할 수가 있습니다.
declaredType파라미터를 사용한 비정렬화 메소드에 의해,JAXBContext에 루트 요소의 XML 명의 매핑이 포함되지 않을 때에서도, XML 데이터의 루트 요소를 직렬화 복원할 수가 있습니다. unmarshaller 는, 어플리케이션이 제공한 매핑을 사용해 루트 요소를 비정렬화합니다. 이 매핑은 declaredType 파라미터로서 지정됩니다. 이러한 비정렬화 메소드를 사용하는 경우, 루트 요소의 요소명이JAXBContext로 맵 되고 있는 경우여도, 루트 요소를 직렬화 복원하기 위한 매핑을declaredType파라미터가 오버라이드(override) 합니다. 또, XML 데이터의 루트 요소에 xsi:type 속성이 있어, 그 속성의 값이JAXBContext에 의해 JAXB 맵 클래스에 맵 되고 있는 형태 정의를 참조하고 있는 경우는, 루트 요소의 xsi:type 속성이 비정렬화 메소드의 declaredType 파라미터보다 우선됩니다. 이러한 메소드는 일반적으로,JAXBElement<declaredType> 인스턴스를 돌려줍니다. 다음의 테이블은, 반환값의 JAXBElement 인스턴스의 프로퍼티이 어떻게 설정되어 있는지를 나타냅니다.
선언형에 의한 비정렬화가 돌려준 JAXBElement JAXBElement 프로퍼티 치 name XML 요소명value declaredType 의 인스턴스declaredType 비정렬화 메소드의 declaredType파라미터scope null(실제의 스코프가 불명)
declaredType 에 의한 비정렬화 메소드의 예를 다음에 나타냅니다.
org.w3c.dom.Node 로부터의 declaredType 에 의한 비정렬화를 실행합니다.
schema fragment예
<xs:schema>
<xs:complexType name="FooType">...<\xs:complexType>
<! -- global element declaration "PurchaseOrder" -->
<xs:element name="PurchaseOrder">
<xs:complexType>
<xs:sequence>
<! -- local element declaration "foo" -->
<xs:element name="foo" type="FooType"/>
...
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
Unmarshaller u = jc.createUnmarshaller();
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
DocumentBuilder db = dbf.newDocumentBuilder();
Document doc = db.parse(new File( "nosferatu.xml"));
Element fooSubtree = ...; // traverse DOM till reach xml element foo, constrained by a
// local element declaration in schema.
// FooType is the JAXB mapping of the type of local element declaration foo.
JAXBElement<FooType> foo = u.unmarshal( fooSubtree, FooType.class);
SAX2. 0 준거 퍼서의 지원
클라이언트 어플리케이션은, 각각이 선택한 SAX2. 0 준거 퍼서를 선택할 수가 있습니다. SAX 퍼서가 선택되지 않는 경우, JAXB 프로바이더의 디폴트 퍼서가 사용됩니다. JAXB 프로바이더의 디폴트 퍼서가 SAX2. 0 준거일 필요는 없기는 하지만, 모든 프로바이더는 클라이언트 어플리케이션이 SAX2. 0 퍼서를 지정할 수 있도록(듯이) 할 필요가 있습니다. 프로바이더에 따라서는, schema 컴파일시에 SAX2. 0 퍼서를 지정하는 것을 클라이언트 어플리케이션에 요구하는 경우도 있습니다. 자세한 것은,unmarshal(Source) 를 참조해 주세요.
검증과 정형식
클라이언트 어플리케이션은,setSchema(javax.xml.validation.Schema) API 를 개입시켜 JAXP 1.3 검증 기구를 유효 또는 무효로 할 수 있습니다. 고도의 클라이언트는,
unmarshal(Source)API 를 사용해, 그것 자신의 검증 SAX 2.0 준거 퍼서를 지정해, JAXP 1.3 검증 기구를 회피할 수 있습니다.무효인 XML 컨텐츠의 비정렬화는 JAXB 2.0 으로 정의되고 있기 (위해)때문에, Unmarshaller 의 디폴트 검증 이벤트 핸들러는 JAXB 1.0 보다 보다 관대하게 처리됩니다. JAXB 1.0 바인딩 컴파일러에 의해 생성된 schema 파생 코드가
JAXBContext에 등록되어 있는 경우, 디폴트비정렬화 검증 핸들러는DefaultValidationEventHandler이며, 치명적인 에러 또는 에러의 발생 후에 정렬화 조작을 종료시킵니다. JAXB 2.0 클라이언트 어플리케이션의 경우, 명시적으로 정의된 디폴트 검증 핸들러가 없고, 디폴트 이벤트 처리는 치명적인 에러의 발생 후에 정렬화 조작을 종료시킬 뿐입니다.
현재, Unmarshaller 에 관해서 모든 JAXB 프로바이더가 지원할 필요가 있는 프로퍼티은 없습니다. 그러나, 일부의 프로바이더는, 프로바이더 고유의 프로퍼티의 고유세트를 지원하는 경우가 있습니다.
Unmarshaller는, 2 개의 스타일의 콜백 기구를 제공합니다. 이것들에 의해, 비정렬화 프로세스의 중요한 시점에서의 어플리케이션 고유의 처리가 가능하게 됩니다. 「클래스 정의되었다」이벤트 콜백에서는, JAXB 맵 클래스에 놓여진 어플리케이션 고유의 코드가 비정렬화중에 트리거됩니다. 「외부 청취자」는, 형태의 이벤트 콜백을 개입시키는 것이 아니라, 한 번의 콜백 메소드에서의 비정렬화 이벤트의 집중 처리를 가능하게 합니다.「클래스 정의되었다」이벤트 콜백 메소드에 의해, 임의의 JAXB 맵 클래스는 다음의 메소드시그니챠를 가지는 메소드를 정의하는 것에 의해, 고유의 콜백 메소드를 지정할 수 있습니다.
콜백 메소드가 클래스의 public 이외의 메소드 또는 필드에의 액세스를 필요로 하는 경우는, 클래스 정의 콜백 메소드를 사용할 필요가 있습니다.// This method is called immediately after the object is created and before the unmarshalling of this // object begins.The callback provides an opportunity to initialize JavaBean properties prior to unmarshalling. void beforeUnmarshal(Unmarshaller, Object parent); //This method is called after all the properties (except IDREF) are unmarshalled for this object, //but before this object is set to the parent object. void afterUnmarshal(Unmarshaller, Object parent);외부 청취자 콜백 기구에서는,
setListener(Listener)에Unmarshaller.Listener인스턴스를 등록할 수가 있습니다. 외부 청취자는 모든 콜백 이벤트를 받기 (위해)때문에, 클래스 마다 정의되는 콜백 메소드보다, 보다 집중적인 처리가 가능하게 됩니다. 비정렬화 프로세스가 JAXB 요소 또는 JAXB 맵 클래스에 정렬화하려고 했을 경우, 외부 청취자는 이벤트를 받습니다.「클래스 정의되었다」이벤트 콜백 메소드와 외부 청취자 이벤트 콜백 메소드는 각각 독립하고 있어, 1 개의 이벤트에 대해 양쪽 모두를 호출할 수가 있습니다. 양쪽 모두의 청취자 콜백 메소드가 존재하는 경우의 호출 순서는,
Unmarshaller.Listener.beforeUnmarshal(Object, Object)및Unmarshaller.Listener.afterUnmarshal(Object, Object)로 정의됩니다.예외를 throw 한 이벤트 콜백 메소드는, 현재의 정렬화 프로세스를 종료시킵니다.
JAXBContext ,
Marshaller ,
Validator | 상자의 클래스의 개요 | |
|---|---|
static class |
Unmarshaller.Listener
Unmarshaller 에 이 클래스의 구현의 인스턴스를 등록해, 비정렬화 이벤트를 외부적으로 대기합니다. |
| 메소드의 개요 | ||
|---|---|---|
|
getAdapter (Class <A> type)
지정한 형태에 관련지을 수 있고 있는 어댑터를 가져옵니다. |
|
AttachmentUnmarshaller |
getAttachmentUnmarshaller ()
|
|
ValidationEventHandler |
getEventHandler ()
현재의 이벤트 핸들러, 또는, 그것이 설정되어 있지 않은 경우는 디폴트 이벤트 핸들러를 돌려줍니다. |
|
Unmarshaller.Listener |
getListener ()
이 Unmarshaller 에 등록되어 있는 Unmarshaller.Listener 를 돌려줍니다. |
|
Object |
getProperty (String name)
Unmarshaller 의 기본이 되는 구현의 특정의 프로퍼티을 가져옵니다. |
|
Schema |
getSchema ()
비정렬화시의 검증에 사용되고 있는 JAXP 1.3 Schema 객체를 가져옵니다. |
|
UnmarshallerHandler |
getUnmarshallerHandler ()
XML 파이프라인의 컴퍼넌트로서 사용할 수 있는, unmarshaller 핸들러 객체를 가져옵니다. |
|
boolean |
isValidating ()
추천 되고 있지 않습니다. since JAXB2. 0, getSchema() 를 참조 |
|
|
setAdapter (Class <A> type,
A adapter)
XmlAdapter 의 설정 끝난 인스턴스를 이 Unmarshaller 에 관련짓습니다. |
|
void |
setAdapter (XmlAdapter adapter)
XmlAdapter 의 설정 끝난 인스턴스를 이 Unmarshaller 에 관련짓습니다. |
|
void |
setAttachmentUnmarshaller (AttachmentUnmarshaller au)
cid, 컨텐츠 ID URI 를, 첨부로서 건네받은 바이너리 데이터에 해결하는 문맥을 관련짓습니다. |
|
void |
setEventHandler (ValidationEventHandler handler)
어플리케이션이 ValidationEventHandler 를 등록할 수가 있습니다. |
|
void |
setListener (Unmarshaller.Listener listener)
이 Unmarshaller 에 비정렬화 이벤트 콜백 Unmarshaller.Listener 를 등록합니다. |
|
void |
setProperty (String name,
Object value)
Unmarshaller 의 기본이 되는 구현에 특정의 프로퍼티을 설정합니다. |
|
void |
setSchema (Schema schema)
후의 비정렬화 조작의 검증에 사용하는, JAXP 1.3 Schema 객체를 지정합니다. |
|
void |
setValidating (boolean validating)
추천 되고 있지 않습니다. since JAXB2. 0, setSchema(javax.xml.validation.Schema) 를 참조 |
|
Object |
unmarshal (File f)
지정된 파일로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (InputSource source)
지정된 SAX InputSource 로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (InputStream is)
지정된 InputStream 로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (Node node)
지정된 DOM 트리로부터 글로벌 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
|
unmarshal (Node node,
Class <T> declaredType)
JAXB 맵 declaredType 에 의해 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (Reader reader)
지정된 Reader 로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (Source source)
지정된 XML Source 로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
|
unmarshal (Source source,
Class <T> declaredType)
declaredType 에 근거해, 지정된 XML Source 로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (URL url)
지정된 URL 로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (XMLEventReader reader)
지정된 프르파서로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
|
unmarshal (XMLEventReader reader,
Class <T> declaredType)
JAXB 맵 declaredType 에 루트 요소를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
Object |
unmarshal (XMLStreamReader reader)
지정된 프르파서로부터 XML 데이터를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
|
unmarshal (XMLStreamReader reader,
Class <T> declaredType)
JAXB 맵 declaredType 에 루트 요소를 비정렬화해, 결과의 컨텐츠 트리를 돌려줍니다. |
|
| 메소드의 상세 |
|---|
Object unmarshal(File f)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
f - 비정렬화하는 XML 데이터가 포함되는 파일
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - file 파라미터가 null 의 경우
Object unmarshal(InputStream is)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
is - 비정렬화하는 XML 데이터가 포함되는 InputStream
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - InputStream 파라미터가 null 의 경우
Object unmarshal(Reader reader)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
reader - 비정렬화하는 XML 데이터가 포함되는 Reader
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - InputStream 파라미터가 null 의 경우
Object unmarshal(URL url)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
url - 비정렬화하는 XML 데이터가 포함되는 URL
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - URL 파라미터가 null 의 경우
Object unmarshal(InputSource source)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
source - 비정렬화하는 XML 데이터가 포함되는 입력 소스
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - InputSource 파라미터가 null 의 경우
Object unmarshal(Node node)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
node - 비정렬화하는 XML 데이터가 포함되는 문서 또는 요소.
호출측은 최저한, 문서와 요소를 지원할 필요가 있다
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - Node 파라미터가 null 의 경우unmarshal(org.w3c.dom.Node, Class)
<T> JAXBElement <T> unmarshal(Node node,
Class <T> declaredType)
throws JAXBException
「선언형에 의한 비정렬화」를 구현합니다.
node - 비정렬화하는 XML 데이터가 포함되는 문서 또는 요소.
호출측은 최저한, 문서와 요소를 지원할 필요가 있는declaredType - node 의 XML 데이터를 보관 유지하는, 적절한 JAXB 맵 클래스
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - 임의의 파라미터가 null의 경우
Object unmarshal(Source source)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
클라이언트 어플리케이션은, 그 JAXB 프로바이더로 제공되고 있는 디폴트 퍼서 기구를 사용하지 않는 것을 선택할 수 있습니다. 임의의 SAX 2.0 준거 퍼서를, JAXB 프로바이더의 디폴트 기구에 치환할 수가 있습니다. 이것을 실시하기 (위해)때문에, 클라이언트 어플리케이션은, SAX 2.0 퍼서 프로바이더가 구현하고 있는 XMLReader 를 포함한 SAXSource 를 적절히 설정할 필요가 있습니다. XMLReader 에 org.xml.sax.ErrorHandler 가 등록되어 있는 경우, 그것이 JAXB 프로바이더에 의해 옮겨놓을 수 있어 검증 에러는 JAXB 의 ValidationEventHandler 기구를 개입시켜 보고될 가능성이 있습니다. SAXSource 에 XMLReader 가 포함되지 않는 경우, JAXB 프로바이더의 디폴트 퍼서 기구가 사용됩니다.
이 퍼서 치환 기구는, JAXB 프로바이더의 비정렬화시의 검증 엔진의 치환에도 사용할 수 있습니다. 클라이언트 어플리케이션은, (전술의 예에 나타낸 것처럼) 그 SAX 2.0 준거 퍼서가 검증을 실행하도록(듯이) 적절히 설정할 필요가 있습니다. 비정렬화 조작중에 퍼서가 SAXParserExceptions 에 조우하면(자), JAXB 프로바이더가 그것을 처리해, JAXB ValidationEvent 객체에 변환됩니다. 이 객체는,Unmarshaller 에 등록되어 있는 ValidationEventHandler 를 개입시켜 클라이언트에 보고됩니다. 주: 비정렬화에 대체의 검증 SAX 2.0 퍼서를 지정했을 경우에서도, On Demand의 검증을 실행하기 위해서 JAXB 프로바이더가 사용하는 검증 엔진은 반드시 옮겨놓을 수 없습니다.
비정렬화중에 사용되는 다른 퍼서 기구를 클라이언트 어플리케이션을 지정할 수 있는 유일한 방법은,unmarshal(SAXSource) API 를 개입시키는 방법입니다. 비정렬화 메소드의 다른 모든 형식 (File, URL, Node 등)은, JAXB 프로바이더의 디폴트의 퍼서와 발리 데이터 기구를 사용합니다.
source - 비정렬화하는 XML 데이터가 포함되는 XML Source (프로바이더는,
SAXSource, DOMSource, StreamSource 를 지원할 필요가 있을 뿐)
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - Source 파라미터가 null 의 경우unmarshal(javax.xml.transform.Source, Class)
<T> JAXBElement <T> unmarshal(Source source,
Class <T> declaredType)
throws JAXBException
「선언형에 의한 비정렬화」를 구현합니다.
「플러그 인 가능한 SAX 2.0 퍼서」를 참조해 주세요.
source - 비정렬화하는 XML 데이터가 포함되는 XML Source (프로바이더는,
SAXSource, DOMSource, StreamSource 를 지원할 필요가 있을 뿐)declaredType - source 의 XML 루트 요소를 보관 유지하는, 적절한 JAXB 맵 클래스
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - 임의의 파라미터가 null의 경우
Object unmarshal(XMLStreamReader reader)
throws JAXBException
글로벌 루트 요소의 비정렬화를 구현합니다.
이 메소드는, 퍼서에서의 START_DOCUMENT 또는 START_ELEMENT 이벤트의 발생을 전제로 하고 있습니다. 비정렬화는, 이 start 이벤트로부터, 대응하는 end 이벤트까지의 사이에 실행됩니다. 이 메소드가 정상적인 결과를 돌려주는 경우,reader 는, end 이벤트의 직후의 토큰을 포인트 합니다.
reader - 읽히는 퍼서
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - reader 파라미터가 null 의 경우
IllegalStateException - reader 가 START_DOCUMENT 또는 START_ELEMENT
이벤트를 포인트 하고 있지 않는 경우unmarshal(javax.xml.stream.XMLStreamReader, Class)
<T> JAXBElement <T> unmarshal(XMLStreamReader reader,
Class <T> declaredType)
throws JAXBException
이 메소드는,선언형에 의한 비정렬화를 구현합니다.
이 메소드는, 퍼서에서의 START_DOCUMENT 또는 START_ELEMENT 이벤트의 발생을 전제로 하고 있습니다. 비정렬화는, 이 start 이벤트로부터, 대응하는 end 이벤트까지의 사이에 실행됩니다. 이 메소드가 정상적인 결과를 돌려주는 경우,reader 는, end 이벤트의 직후의 토큰을 포인트 합니다.
reader - 읽히는 퍼서declaredType - reader 의 START_ELEMENT XML 데이터를 보관 유지하는, 적절한 JAXB 맵 클래스
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - 임의의 파라미터가 null의 경우
Object unmarshal(XMLEventReader reader)
throws JAXBException
이 메소드는,글로벌 루트의 비정렬화 메소드입니다.
이 메소드는, 퍼서에서의 START_DOCUMENT 또는 START_ELEMENT 이벤트의 발생을 전제로 하고 있습니다. 비정렬화는, 이 start 이벤트로부터, 대응하는 end 이벤트까지의 사이에 실행됩니다. 이 메소드가 정상적인 결과를 돌려주는 경우,reader 는, end 이벤트의 직후의 토큰을 포인트 합니다.
reader - 읽히는 퍼서
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - reader 파라미터가 null 의 경우
IllegalStateException - reader 가 START_DOCUMENT 또는 START_ELEMENT
이벤트를 포인트 하고 있지 않는 경우unmarshal(javax.xml.stream.XMLEventReader, Class)
<T> JAXBElement <T> unmarshal(XMLEventReader reader,
Class <T> declaredType)
throws JAXBException
이 메소드는,선언형에 의한 비정렬화를 구현합니다.
이 메소드는, 퍼서에서의 START_DOCUMENT 또는 START_ELEMENT 이벤트의 발생을 전제로 하고 있습니다. 비정렬화는, 이 start 이벤트로부터, 대응하는 end 이벤트까지의 사이에 실행됩니다. 이 메소드가 정상적인 결과를 돌려주는 경우,reader 는, end 이벤트의 직후의 토큰을 포인트 합니다.
reader - 읽히는 퍼서declaredType - reader 의 START_ELEMENT XML 데이터를 보관 유지하는, 적절한 JAXB 맵 클래스
JAXBException - 비정렬화의 실행중에 예상외의 에러가 발생했을 경우
UnmarshalException - ValidationEventHandler 의
handleEvent 메소드로부터 false 가 반환되는지, 또는
Unmarshaller 가 XML 로부터 Java 에의 바인딩을 실행
할 수 없는 경우. 「XML 데이터의 비정렬화」를 참조
IllegalArgumentException - 임의의 파라미터가 null의 경우UnmarshallerHandler getUnmarshallerHandler()
이 메소드를 여러 차례 호출했을 경우, 같은 핸들러 객체가 돌려주어질 가능성이 있습니다. 즉, 이 메소드는 반드시 새로운 UnmarshallerHandler 인스턴스를 작성하지 않습니다. 어플리케이션이 복수의 UnmarshallerHandler 를 사용할 필요가 있는 경우, 복수의 Unmarshaller 를 작성하도록 해 주세요.
UnmarshallerHandler
void setValidating(boolean validating)
throws JAXBException
setSchema(javax.xml.validation.Schema) 를 참조
이 메소드는, 비정렬화 메소드의 어느쪽이든을 호출하기 전, 또는 호출한 뒤에게만, 호출할 수가 있습니다.
이 메소드는, JAXB 프로바이더의 디폴트비정렬화시 검증 기구를 제어할 뿐입니다. 클라이언트 독자적인 검증 SAX 2.0 준거 퍼서의 지정에는 영향을 주지 않습니다. 각자의 비정렬화시 검증 기구를 지정하는 클라이언트가 이 API 를 개입시켜 JAXB 프로바이더의 디폴트 검증 기구를 오프로 해, 「이중 검증」을 회피하는 일이 있습니다.
이 메소드는, JAXB 2.0 의 시점에서 비추천의 메소드입니다. 새로운 setSchema(javax.xml.validation.Schema) API 를 사용해 주세요.
validating - Unmarshaller 가 비정렬화중에 검증해야 할 경우, true.
그 이외의 경우, false
JAXBException - 비정렬화시의 검증을 유효 또는 무효로 하고 있는 도중에
에러가 발생했을 경우
UnsupportedOperationException - JAXB 2.0 맵 클래스를 참조하고 있다
JAXBContext 로부터 작성된 Unmarshaller 에 대해서 이 메소드가 불려 갔을 경우,
throw 될 가능성이 있다
boolean isValidating()
throws JAXBException
getSchema() 를 참조
이 API 는, JAXB 프로바이더의 디폴트비정렬화시 검증 기구 상태를 돌려줍니다.
이 메소드는, JAXB 2.0 의 시점에서 비추천의 메소드입니다. 새로운 getSchema() API 를 사용해 주세요.
JAXBException - 검증 플래그의 취득중에 에러가 발생했을 경우
UnsupportedOperationException - JAXB 2.0 맵 클래스를 참조하고 있다
JAXBContext 로부터 작성된 Unmarshaller 에 대해서 이 메소드가 불려 갔을 경우,
throw 될 가능성이 있다
void setEventHandler(ValidationEventHandler handler)
throws JAXBException
ValidationEventHandler 는, 몇개의 비정렬화 메소드를 호출하고 있는 도중에 검증 에러가 발생했을 경우, JAXB 프로바이더에 의해 불려 갑니다. 비정렬화 메소드를 호출하기 전에 클라이언트 어플리케이션이 ValidationEventHandler 를 등록하고 있지 않는 경우,ValidationEvents 는 디폴트 이벤트 핸들러에 의해 처리됩니다. 디폴트 이벤트 핸들러는, 최초의 에러 또는 치명적인 에러의 발생 후에 비정렬화 조작을 종료시킵니다.
이 메소드를 null 파라미터와 함께 호출했을 경우, Unmarshaller 는 디폴트 이벤트 핸들러에 돌아옵니다.
handler - 검증 이벤트 핸들러
JAXBException - 이벤트 핸들러의 설정중에 에러가 발생했을 경우
ValidationEventHandler getEventHandler()
throws JAXBException
JAXBException - 현재의 이벤트 핸들러의 취득중에 에러가 발생했을 경우
void setProperty(String name,
Object value)
throws PropertyException
name - 설정하는 프로퍼티의 이름. 이 값은, 정수 필드의 1 개인가
사용자 지정 캐릭터 라인을 사용해 지정할 수 있는value - 설정하는 프로퍼티의 값
PropertyException - 주어진 프로퍼티 또는 값의 처리중에 에러가
발생했을 경우
IllegalArgumentException - name 파라미터가 null 의 경우
Object getProperty(String name)
throws PropertyException
name - 취득하는 프로퍼티의 이름
PropertyException - 지정한 프로퍼티, 또는 프로퍼티명치의 취득중에 에러가 발생
했을 경우
IllegalArgumentException - name 파라미터가 null 의 경우void setSchema(Schema schema)
Schema 객체를 지정합니다. 이 메소드에 null 를 건네주면(자), 검증은 무효가 됩니다.
이 메소드는, 추천 되지 않게 된 setValidating(boolean) API 에 옮겨지는 것입니다.
이 프로퍼티은 최초로 null 로 설정됩니다.
schema - 비정렬화 조작의 검증에 사용하는 schema 객체. 검증을 무효로 하는 경우는 null
UnsupportedOperationException - JAXB 2.0 맵 클래스를 참조하고 있다
JAXBContext 로부터 작성된 Unmarshaller 에 대해서 이 메소드가 불려 갔을 경우,
throw 될 가능성이 있는Schema getSchema()
Schema 객체를 가져옵니다. Unmarshaller 에 schema가 설정되어 있지 않은 경우, 이 메소드는, 비정렬화시에 검증을 실행하지 않는 것을 나타내는, null 를 돌려줍니다.
이 메소드는, 추천 되지 않게 된 isValidating() API 에 옮겨지는 것과 동시에, Schema 객체에의 액세스를 제공합니다. Unmarshaller 가 검증을 유효하게 하고 있을지 어떨지를 판단하려면 , 반환값의 형태와 null 를 대조해 체크하면 간단하게 압니다.
boolean isValidating = u.getSchema()! =null;
UnsupportedOperationException - JAXB 2.0 맵 클래스를 참조하고 있다
JAXBContext 로부터 작성된 Unmarshaller 에 대해서 이 메소드가 불려 갔을 경우,
throw 될 가능성이 있는void setAdapter(XmlAdapter adapter)
XmlAdapter 의 설정 끝난 인스턴스를 이 Unmarshaller 에 관련짓습니다.
이것은,setAdapter(adapter.getClass(), adapter); 를 호출하는 편리한 메소드입니다.
IllegalArgumentException - adapter 파라미터가 null 의 경우
UnsupportedOperationException - JAXB 1.0 구현에 대해서 불려 갔을 경우setAdapter(Class, XmlAdapter)
<A extends XmlAdapter > void setAdapter(Class <A> type,
A adapter)
XmlAdapter 의 설정 끝난 인스턴스를 이 Unmarshaller 에 관련짓습니다.
모든 Unmarshaller 는, 내부적으로 Map <Class ,XmlAdapter > 를 보관 유지하고 있어, 필드 또는 메소드가 XmlJavaTypeAdapter 로 주석 된 클래스를 비정렬화하기 위해서(때문에) 사용합니다.
이 메소드에 의해, 어플리케이션은 XmlAdapter 의 설정 끝난 인스턴스를 사용할 수가 있습니다. 어댑터의 인스턴스가 주어지지 않는 경우, Unmarshaller 는 그 디폴트 생성자 을 호출해 인스턴스를 작성합니다.
type - 어댑터의 형태. XmlJavaTypeAdapter.value()
하지만 이 형태를 참조하고 있는 경우, 지정된 인스턴스가 사용되는adapter - 사용하는 어댑터의 인스턴스. null 의 경우, 이 형태의 현재의 어댑터
세트의 등록을 취소한다
IllegalArgumentException - type 파라미터가 null 의 경우
UnsupportedOperationException - JAXB 1.0 구현에 대해서 불려 갔을 경우<A extends XmlAdapter > A getAdapter(Class <A> type)
setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter) 메소드의 역의 조작입니다.
IllegalArgumentException - type 파라미터가 null 의 경우
UnsupportedOperationException - JAXB 1.0 구현에 대해서 불려 갔을 경우void setAttachmentUnmarshaller(AttachmentUnmarshaller au)
cid, 컨텐츠 ID URI 를, 첨부로서 건네받은 바이너리 데이터에 해결하는 문맥을 관련짓습니다.
비정렬화시의 검증은,setSchema(Schema) 를 개입시켜 유효화 되어 Unmarshaller 가 XOP 처리를 실행하는 경우에서도 지원할 필요가 있습니다.
IllegalStateException - 정렬화 조작중에, 이 메소드를 동시에
호출하려고 했을 경우AttachmentUnmarshaller getAttachmentUnmarshaller()
void setListener(Unmarshaller.Listener listener)
이 Unmarshaller 에 비정렬화 이벤트 콜백 Unmarshaller.Listener 를 등록합니다.
각 Unmarshaller 에 Listener 는 1 개 뿐입니다. Listener 를 설정하면(자), 전으로 설정되어 있던 Listener 와 옮겨집니다. Listener 에 null 를 설정하는 것으로써, 현재의 Listener 의 등록을 해제할 수 있습니다.
listener - 이 Unmarshaller 에 비정렬화 이벤트 콜백을 제공하는Unmarshaller.Listener getListener()
이 Unmarshaller 에 등록되어 있는 Unmarshaller.Listener 를 돌려줍니다.
Unmarshaller.Listener , 또는, 이 Unmarshaller 에 등록되어 있는 Listener 가 없는 경우,null
|
JavaTM Platform Standard Ed. 6 |
|||||||||
| 앞의 클래스 다음의 클래스 | 프레임 있어 프레임 없음 | |||||||||
| 개요 : 상자 | 필드 | 생성자 | 메소드 | 상세: 필드 | 생성자 | 메소드 | |||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms . Documentation Redistribution Policy 도 참조해 주세요.