diff options
Diffstat (limited to 'tests/src')
4 files changed, 20 insertions, 13 deletions
diff --git a/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractKeyboardBuilder.java b/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractKeyboardBuilder.java index 3365b92ec..6e721047c 100644 --- a/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractKeyboardBuilder.java +++ b/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractKeyboardBuilder.java @@ -21,9 +21,9 @@ import java.util.Arrays; /** * This class builds a keyboard that is a two dimensional array of elements <code>E</code>. * - * A keyboard consists of array of rows, and a row consists of array of elements. Each row may have - * different number of elements. A element of a keyboard can be specified by a row number and a - * column number, both numbers starts from 1. + * A keyboard consists of an array of rows, and a row consists of an array of elements. Each row + * may have different number of elements. A element of a keyboard can be specified by a row number + * and a column number, both numbers starts from 1. * * @param <E> the type of a keyboard element. A keyboard element must be an immutable object. */ @@ -39,8 +39,7 @@ abstract class AbstractKeyboardBuilder<E> { abstract E[][] newArrayOfArray(final int size); /** - * Construct a builder filled with the default element. - * @param dimensions the integer array of each row's size. + * Construct an empty builder. */ AbstractKeyboardBuilder() { mRows = newArrayOfArray(0); @@ -80,7 +79,7 @@ abstract class AbstractKeyboardBuilder<E> { * Get the current contents of the specified row. * @param row the row number to get the contents. * @return the array of elements at row number <code>row</code>. - * @throws {@link RuntimeException} if <code>row</code> is illegal. + * @throws RuntimeException if <code>row</code> is illegal. */ E[] getRowAt(final int row) { final int rowIndex = row - 1; @@ -94,7 +93,7 @@ abstract class AbstractKeyboardBuilder<E> { * Set an array of elements to the specified row. * @param row the row number to set <code>elements</code>. * @param elements the array of elements to set at row number <code>row</code>. - * @throws {@link RuntimeException} if <code>row</code> is illegal. + * @throws RuntimeException if <code>row</code> is illegal. */ void setRowAt(final int row, final E[] elements) { final int rowIndex = row - 1; @@ -114,7 +113,7 @@ abstract class AbstractKeyboardBuilder<E> { * @param element the element to set or insert at <code>row,column</code>. * @param insert if true, the <code>element</code> is inserted at <code>row,column</code>. * Otherwise the <code>element</code> replace the element at <code>row,column</code>. - * @throws {@link RuntimeException} if <code>row</code> or <code>column</code> is illegal. + * @throws RuntimeException if <code>row</code> or <code>column</code> is illegal. */ void setElementAt(final int row, final int column, final E element, final boolean insert) { final E[] elements = getRowAt(row); diff --git a/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractLayoutBase.java b/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractLayoutBase.java index 25be2a68b..9e0039d84 100644 --- a/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractLayoutBase.java +++ b/tests/src/com/android/inputmethod/keyboard/layout/expected/AbstractLayoutBase.java @@ -19,7 +19,6 @@ package com.android.inputmethod.keyboard.layout.expected; import com.android.inputmethod.keyboard.internal.KeyboardIconsSet; import com.android.inputmethod.keyboard.layout.expected.ExpectedKey.ExpectedAdditionalMoreKey; import com.android.inputmethod.latin.Constants; -import com.android.inputmethod.latin.utils.StringUtils; /** * Base class to create an expected keyboard for unit test. diff --git a/tests/src/com/android/inputmethod/keyboard/layout/expected/ActualKeyboardBuilder.java b/tests/src/com/android/inputmethod/keyboard/layout/expected/ActualKeyboardBuilder.java index 26d2e2ad2..d0fea58b0 100644 --- a/tests/src/com/android/inputmethod/keyboard/layout/expected/ActualKeyboardBuilder.java +++ b/tests/src/com/android/inputmethod/keyboard/layout/expected/ActualKeyboardBuilder.java @@ -28,6 +28,9 @@ import java.util.List; /** * This class builds an actual keyboard for unit test. + * + * An actual keyboard is an array of rows, and a row consists of an array of {@link Key}s. + * Each row may have different number of {@link Key}s. */ public final class ActualKeyboardBuilder extends AbstractKeyboardBuilder<Key> { private static ArrayList<Key> filterOutSpacer(final List<Key> keys) { @@ -43,7 +46,8 @@ public final class ActualKeyboardBuilder extends AbstractKeyboardBuilder<Key> { /** * Create the keyboard that consists of the array of rows of the actual keyboard's keys. - * @param sortedKeys the sorted list of keys of the actual keyboard. + * @param sortedKeys keys list of the actual keyboard that is sorted from top-left to + * bottom-right. * @return the actual keyboard grouped with rows. */ public static Key[][] buildKeyboard(final List<Key> sortedKeys) { diff --git a/tests/src/com/android/inputmethod/keyboard/layout/expected/ExpectedKeyboardBuilder.java b/tests/src/com/android/inputmethod/keyboard/layout/expected/ExpectedKeyboardBuilder.java index f068ad11d..e06d34d67 100644 --- a/tests/src/com/android/inputmethod/keyboard/layout/expected/ExpectedKeyboardBuilder.java +++ b/tests/src/com/android/inputmethod/keyboard/layout/expected/ExpectedKeyboardBuilder.java @@ -24,6 +24,11 @@ import java.util.Locale; /** * This class builds an expected keyboard for unit test. + * + * An expected keyboard is an array of rows, and a row consists of an array of {@link ExpectedKey}s. + * Each row may have different number of {@link ExpectedKey}s. While building an expected keyboard, + * an {@link ExpectedKey} can be specified by a row number and a column number, both numbers starts + * from 1. */ public final class ExpectedKeyboardBuilder extends AbstractKeyboardBuilder<ExpectedKey> { public ExpectedKeyboardBuilder() { @@ -212,7 +217,7 @@ public final class ExpectedKeyboardBuilder extends AbstractKeyboardBuilder<Expec * @param keys the array of keys to insert at <code>row,column</code>. Each key can be * {@link ExpectedKey}, {@link ExpectedKey} array, and {@link String}. * @return this builder. - * @throws {@link RuntimeException} if <code>row</code> or <code>column</code> is illegal. + * @throws RuntimeException if <code>row</code> or <code>column</code> is illegal. */ public ExpectedKeyboardBuilder insertKeysAtRow(final int row, final int column, final Object ... keys) { @@ -229,7 +234,7 @@ public final class ExpectedKeyboardBuilder extends AbstractKeyboardBuilder<Expec * @param keys the array of keys to add on the left most of the row. Each key can be * {@link ExpectedKey}, {@link ExpectedKey} array, and {@link String}. * @return this builder. - * @throws {@link RuntimeException} if <code>row</code> is illegal. + * @throws RuntimeException if <code>row</code> is illegal. */ public ExpectedKeyboardBuilder addKeysOnTheLeftOfRow(final int row, final Object ... keys) { @@ -247,7 +252,7 @@ public final class ExpectedKeyboardBuilder extends AbstractKeyboardBuilder<Expec * @param keys the array of keys to add on the right most of the row. Each key can be * {@link ExpectedKey}, {@link ExpectedKey} array, and {@link String}. * @return this builder. - * @throws {@link RuntimeException} if <code>row</code> is illegal. + * @throws RuntimeException if <code>row</code> is illegal. */ public ExpectedKeyboardBuilder addKeysOnTheRightOfRow(final int row, final Object ... keys) { |