SafeXmlPullParser.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.waveprotocol.wave.model.document.parser;

import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * Xml pull parser interface.
 *
 * Returns a stream of tokens, i.e. start element, end element and text.
 *
 */
public interface SafeXmlPullParser extends Iterator<ItemType>, XmlPullParser {
  /**
   * @return if the parser has more tokens.
   */
  boolean hasNext();

  /**
   * Move to the next token
   * @return The type of item we are at
   * @throws NoSuchElementException if there are no tokens left
   */
  ItemType next() throws NoSuchElementException;
}