org.opensaml.xml.io.Unmarshaller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmltooling Show documentation

XMLTooling-J is a low-level library that may be used to construct libraries that allow developers to work with XML in a Java beans manner.

There is a newer version: 1.4.2

Show newest version

/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You under the Apache 
 * License, Version 2.0 (the "License"); you may not use this file except in 
 * compliance with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.opensaml.xml.io;

import org.opensaml.xml.XMLObject;
import org.w3c.dom.Element;

/**
 * Unmarshallers are used to unmarshall a W3C DOM element into a {@link org.opensaml.xml.XMLObject}.
 */
public interface Unmarshaller {

    /**
     * Unmarshalls the given W3C DOM element into a XMLObject.
     * 
     * @param element the DOM Element
     * 
     * @return the unmarshalled XMLObject
     * 
     * @throws UnmarshallingException thrown if an error occurs unmarshalling the DOM element into the XMLObject
     */
    public XMLObject unmarshall(Element element) throws UnmarshallingException;
}