// Copyright 2010-2014, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package org.mozc.android.inputmethod.japanese;

import org.mozc.android.inputmethod.japanese.JapaneseKeyboard.KeyboardSpecification;
import org.mozc.android.inputmethod.japanese.keyboard.Keyboard;
import org.mozc.android.inputmethod.japanese.keyboard.KeyboardParser;
import org.mozc.android.inputmethod.japanese.keyboard.Row;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;

import android.content.res.Resources;
import android.content.res.XmlResourceParser;

import org.xmlpull.v1.XmlPullParserException;

import java.io.IOException;
import java.util.List;

/**
 */
public class JapaneseKeyboardParser extends KeyboardParser {
  private final KeyboardSpecification specification;

  public JapaneseKeyboardParser(
      Resources resources, XmlResourceParser parser, KeyboardSpecification specification,
      int keyboardWidth, int keyboardHeight) {
    super(resources, parser, keyboardWidth, keyboardHeight);
    if (specification == null) {
      throw new NullPointerException("specification is null.");
    }
    this.specification = specification;
  }

  /**
   * Parses a XML file and returns the keyboard instance.
   * @return JapaneseKeyboard instance parsed from the resource.
   * @throws XmlPullParserException is thrown if parsing is failed.
   * @throws IOException is thrown if there is trouble to read data.
   */
  @Override
  public JapaneseKeyboard parseKeyboard() throws XmlPullParserException, IOException {
    return JapaneseKeyboard.class.cast(super.parseKeyboard());
  }

  @Override
  protected Keyboard buildKeyboard(Optional<String> contentDescription,
                                   List<Row> rowList, float flickThreshold) {
    return new JapaneseKeyboard(Preconditions.checkNotNull(contentDescription),
                                Preconditions.checkNotNull(rowList), flickThreshold,
                                specification);
  }
}