Added FileData into javadocs

Signed-off-by: Marcin Woźniak <y0rune@aol.com>
This commit is contained in:
Marcin Woźniak 2020-12-01 21:31:06 +01:00
parent 708cedf7b4
commit e6fffba899
Signed by: y0rune
GPG Key ID: F204C385F57EB348

View File

@ -9,27 +9,54 @@ public class FileData {
private HashMap<String, Integer> keys; private HashMap<String, Integer> keys;
private Iterator<Row> rows; private Iterator<Row> rows;
/*
* FileData
*
* @param keys this is a hashmap of String and Integer
* @param rows this is a iterator of rows.
*/
public FileData(HashMap<String, Integer> keys, Iterator<Row> rows) { public FileData(HashMap<String, Integer> keys, Iterator<Row> rows) {
this.keys = keys; this.keys = keys;
this.rows = rows; this.rows = rows;
} }
/*
* getRows
*
* @return rows
*/
public Iterator<Row> getRows() { public Iterator<Row> getRows() {
return rows; return rows;
} }
/*
* setRows
* @param rows set the rows to given function
*/
public void setRows(Iterator<Row> rows) { public void setRows(Iterator<Row> rows) {
this.rows = rows; this.rows = rows;
} }
/*
* getKeys
* @return keys
*/
public HashMap<String, Integer> getKeys() { public HashMap<String, Integer> getKeys() {
return keys; return keys;
} }
/*
* setKeys
* @param keys set the key is being a struck of hashmap (String, Integer)
*/
public void setKeys(HashMap<String, Integer> keys) { public void setKeys(HashMap<String, Integer> keys) {
this.keys = keys; this.keys = keys;
} }
/*
* getIndexOf
* @return index
*/
public int getIndexOf(String key) { public int getIndexOf(String key) {
int index = this.keys.get(key); int index = this.keys.get(key);
return index; return index;