Merge pull request #4333 from suheb/fix-issue4332

Adding missing docs and keywords for TableRow.
This commit is contained in:
Ben Fry
2016-11-10 11:55:05 -05:00
committed by GitHub

View File

@@ -38,8 +38,17 @@ public interface TableRow {
* @param columnName title of the column to reference
*/
public int getInt(String columnName);
/**
* @webref tablerow:method
* @brief Get a long value from the specified column
* @param column ID number of the column to reference
* @see TableRow#getFloat(int)
* @see TableRow#getString(int)
*/
public long getLong(int column);
/**
* @param columnName title of the column to reference
*/
public long getLong(String columnName);
/**
@@ -54,8 +63,17 @@ public interface TableRow {
* @param columnName title of the column to reference
*/
public float getFloat(String columnName);
/**
* @webref tablerow:method
* @brief Get a double value from the specified column
* @param column ID number of the column to reference
* @see TableRow#getInt(int)
* @see TableRow#getString(int)
*/
public double getDouble(int column);
/**
* @param columnName title of the column to reference
*/
public double getDouble(String columnName);
/**
@@ -85,8 +103,18 @@ public interface TableRow {
* @param columnName title of the target column
*/
public void setInt(String columnName, int value);
/**
* @webref tablerow:method
* @brief Store a long value in the specified column
* @param column ID number of the target column
* @param value value to assign
* @see TableRow#setFloat(int, float)
* @see TableRow#setString(int, String)
*/
public void setLong(int column, long value);
/**
* @param columnName title of the target column
*/
public void setLong(String columnName, long value);
/**
@@ -102,17 +130,54 @@ public interface TableRow {
* @param columnName title of the target column
*/
public void setFloat(String columnName, float value);
/**
* @webref tablerow:method
* @brief Store a double value in the specified column
* @param column ID number of the target column
* @param value value to assign
* @see TableRow#setFloat(int, float)
* @see TableRow#setString(int, String)
*/
public void setDouble(int column, double value);
/**
* @param columnName title of the target column
*/
public void setDouble(String columnName, double value);
/**
* @webref tablerow:method
* @brief Get the column count.
* @return count of all columns
*/
public int getColumnCount();
/**
* @webref tablerow:method
* @brief Get the column type.
* @param columnName title of the target column
* @return type of the column
*/
public int getColumnType(String columnName);
/**
* @param column ID number of the target column
*/
public int getColumnType(int column);
/**
* @webref tablerow:method
* @brief Get the all column types.
* @return list of all column types
*/
public int[] getColumnTypes();
/**
* @webref tablerow:method
* @brief Get the column title.
* @param column ID number of the target column
* @return title of the column
*/
public String getColumnTitle(int column);
/**
* @webref tablerow:method
* @brief Get the all column titles.
* @return list of all column titles
*/
public String[] getColumnTitles();
public void write(PrintWriter writer);