/*   Copyright 2004 The Apache Software Foundation
 *
 *   Licensed 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.apache.xmlbeans.xml.stream;

import org.apache.xmlbeans.xml.stream.XMLInputStream;

/**
 * This interface can be implemented to allow resolution of references
 * on a stream.  
 */
public interface ReferenceResolver {
  /**
   * Returns the xml pointed to by this idref as an XMLInputStream
   * @param idref
   */
  XMLInputStream resolve(String idref)
    throws XMLStreamException;

  /**
   * Returns the id that corresponds to this idref
   * @param idref
   */
  String getId(String idref);
}
