odata2-lib/odata-core/src/main/java/org/apache/olingo/odata2/core/uri/expression/TokenList.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.olingo.odata2.core.uri.expression;

import java.util.ArrayList;
import java.util.Iterator;

import org.apache.olingo.odata2.api.edm.EdmLiteral;

public class TokenList implements Iterator<Token> {
  private ArrayList<Token> tokens = null;
  int currentToken = 0;

  public TokenList() {
    tokens = new ArrayList<Token>();
  }

  /**
   * Append StringValue Token to tokens parameter
   * @param position Position of parsed token
   * @param kind Kind of parsed token
   * @param uriLiteral String value of parsed token
   */
  public void appendToken(final int position, final TokenKind kind, final String uriLiteral) {
    Token token = new Token(kind, position, uriLiteral);
    tokens.add(token);
    return;
  }

  /**
   * Append CharValue Token to tokens parameter
   * @param position Position of parsed token
   * @param kind Kind of parsed token
   * @param charValue Char value of parsed token
   */
  public void appendToken(final int position, final TokenKind kind, final char charValue) {
    Token token = new Token(kind, position, Character.toString(charValue));
    tokens.add(token);
    return;
  }

  /**
   * Append UriLiteral Token to tokens parameter
   * @param position Position of parsed token
   * @param kind Kind of parsed token
   * @param javaLiteral EdmLiteral of parsed token containing type and value of UriLiteral
   */
  public void appendEdmTypedToken(final int position, final TokenKind kind, final String uriLiteral,
      final EdmLiteral javaLiteral) {
    Token token = new Token(kind, position, uriLiteral, javaLiteral);
    tokens.add(token);
    return;
  }

  public Token lookToken() {
    if (currentToken >= tokens.size()) {
      return null;
    }

    return tokens.get(currentToken);
  }

  public Token lookPrevToken() {
    if (currentToken - 1 < 0) {
      return null;
    }

    return tokens.get(currentToken - 1);
  }

  public boolean hasTokens() {
    return (!tokens.isEmpty());
  }

  public int tokenCount() {
    int i = tokens.size();

    return i;
  }

  public Token expectToken(final TokenKind comma) throws TokenizerExpectError {
    Token actual = next();
    if (actual == null) {
      throw TokenizerExpectError.createNO_TOKEN_AVAILABLE(comma.toString());
    }

    if (comma != actual.getKind()) {
      throw TokenizerExpectError.createINVALID_TOKENKIND_AT(comma, actual);
    }
    return actual;
  }

  public Token expectToken(final TokenKind comma, final boolean throwFilterExpression)
      throws ExpressionParserInternalError {
    Token actual = next();
    if (actual == null) {
      throw ExpressionParserInternalError.createNO_TOKEN_AVAILABLE(comma.toString());
    }

    if (comma != actual.getKind()) {
      if (throwFilterExpression) {
        throw ExpressionParserInternalError.createINVALID_TOKENKIND_AT(comma, actual);
      }
    }
    return actual;
  }

  public Token expectToken(final String literal) throws TokenizerExpectError {
    Token actual = next();
    if (actual == null) {
      throw TokenizerExpectError.createNO_TOKEN_AVAILABLE(literal);
    }

    if (!literal.equals(actual.getUriLiteral())) {
      throw TokenizerExpectError.createINVALID_TOKEN_AT(literal, actual);
    }
    return actual;
  }

  public Token expectToken(final String literal, final boolean throwInternal) throws ExpressionParserInternalError {
    Token actual = next();
    if (actual == null) {
      throw ExpressionParserInternalError.createNO_TOKEN_AVAILABLE(literal);
    }

    if (!literal.equals(actual.getUriLiteral())) {
      if (throwInternal) {
        throw ExpressionParserInternalError.createINVALID_TOKEN_AT(literal, actual);
      }
    }
    return actual;
  }

  public void skip() {
    currentToken++;
  }

  @Override
  public boolean hasNext() {
    return (currentToken < tokens.size());
  }

  @Override
  public Token next() {
    if (currentToken >= tokens.size()) {
      return null;
    }

    Token ret = tokens.get(currentToken);
    currentToken++;
    return ret;
  }

  @Override
  public void remove() {
    throw new IllegalArgumentException("Method not allowed");
  }

  public Token elementAt(final int index) {

    return tokens.get(index);
  }

}