View Javadoc

1   /*
2    * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.xml.io;
18  
19  import org.opensaml.xml.XMLObject;
20  import org.w3c.dom.Element;
21  
22  /**
23   * Unmarshallers are used to unmarshall a W3C DOM element into a {@link org.opensaml.xml.XMLObject}.
24   */
25  public interface Unmarshaller {
26  
27      /**
28       * Unmarshalls the given W3C DOM element into a XMLObject.
29       * 
30       * @param element the DOM Element
31       * 
32       * @return the unmarshalled XMLObject
33       * 
34       * @throws UnmarshallingException thrown if an error occurs unmarshalling the DOM element into the XMLObject
35       */
36      public XMLObject unmarshall(Element element) throws UnmarshallingException;
37  }