Javadocs for Table column formats

This commit is contained in:
Aurora Lahtela 2022-09-04 09:05:06 +03:00
parent 91cb569a3c
commit a095eb2178
3 changed files with 57 additions and 0 deletions

View File

@ -24,8 +24,17 @@ import java.util.Optional;
* @author AuroraLS3
*/
public enum Family {
/**
* 'fas' (solid) Font awesome family.
*/
SOLID,
/**
* 'far' (regular) Font awesome family.
*/
REGULAR,
/**
* 'fab' (brand) Font awesome family.
*/
BRAND;
public static Optional<Family> getByName(String name) {

View File

@ -185,22 +185,52 @@ public final class Table {
return this;
}
/**
* Apply formatting to column one.
*
* @param tableColumnFormat Format to apply
* @return Factory.
*/
public Factory columnOneFormat(TableColumnFormat tableColumnFormat) {
return columnFormat(0, tableColumnFormat);
}
/**
* Apply formatting to column two.
*
* @param tableColumnFormat Format to apply
* @return Factory.
*/
public Factory columnTwoFormat(TableColumnFormat tableColumnFormat) {
return columnFormat(1, tableColumnFormat);
}
/**
* Apply formatting to column three.
*
* @param tableColumnFormat Format to apply
* @return Factory.
*/
public Factory columnThreeFormat(TableColumnFormat tableColumnFormat) {
return columnFormat(2, tableColumnFormat);
}
/**
* Apply formatting to column four.
*
* @param tableColumnFormat Format to apply
* @return Factory.
*/
public Factory columnFourFormat(TableColumnFormat tableColumnFormat) {
return columnFormat(3, tableColumnFormat);
}
/**
* Apply formatting to column five.
*
* @param tableColumnFormat Format to apply
* @return Factory.
*/
public Factory columnFiveFormat(TableColumnFormat tableColumnFormat) {
return columnFormat(4, tableColumnFormat);
}

View File

@ -17,10 +17,28 @@
package com.djrapitops.plan.extension.table;
public enum TableColumnFormat {
/**
* String variables to be formatted as links to player page.
*/
PLAYER_NAME,
/**
* String variables to be formatted as colored (using § character).
*/
CHAT_COLORED,
/**
* Number variables to be formatted as time amount (eg. 1h 30m 25s).
*/
TIME_MILLISECONDS,
/**
* Number epoch millisecond to be formatted as date without second indicator.
*/
DATE_YEAR,
/**
* Number epoch millisecond to be formatted as date with second indicator.
*/
DATE_SECOND,
/**
* Default formatting, no extra formatting applied.
*/
NONE
}