XmlNode.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.apache.tuscany.sca.common.xml.stax.reader;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import javax.xml.namespace.QName;

/**
 * @version $Rev$ $Date$
 */
public interface XmlNode {
    enum Type {ELEMENT, ATTRIBUTE, CHARACTERS, READER};
    /**
     * Returns the children of the receiver as an <code>Iterator</code>.
     */
    Iterator<XmlNode> children();

    /**
     * Returns the attributes of the element as an <code>List</code>. Namespace declarations 
     * should be excluded.
     * 
     * @return
     */
    List<XmlNode> attributes();
    
    /**
     * Returns a map of prefix to namespace URI
     * @return
     */
    Map<String, String> namespaces();

    /**
     * Return the QName of the element. If it's for a text node, the name is null.
     * @return
     */
    QName getName();

    /**
     * Return the text value of the leaf element
     * @return
     */
    <T> T getValue();
    
    /**
     * Return the type of the XML node
     * @return
     */
    Type getType();
}