Index (FrostAPI 1.3.2 API)

A C F G I L M P R S T V

A

add(ConsoleColor, String) - Static method in enum com.frostdeveloper.api.utility.ConsoleColor: A method used to add a color to a console message, this method will always automatically include a reset at the end of the string.
addDays(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of days to a date returning a new object.
addDays(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of days to a date returning a new object.
addHours(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of hours to a date returning a new object.
addHours(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of hours to a date returning a new object.
addMilliseconds(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of milliseconds to a date returning a new object.
addMilliseconds(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of milliseconds to a date returning a new object.
addMinutes(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of minutes to a date returning a new object.
addMinutes(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of minutes to a date returning a new object.
addMonths(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of months to a date returning a new object.
addMonths(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of months to a date returning a new object.
addSeconds(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of seconds to a date returning a new object.
addSeconds(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of seconds to a date returning a new object.
addTime(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to add a set amount of time to today's date, it will take a string and try to convert it into a valid time format, for example, '12m' will be parsed as 12 minutes and add 12 minutes to a specific date.
addToList(List<String>, String, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to add a string to a list if a condition is met
addToList(List<Object>, Object, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to add an object to a list if a condition is met
addToList(List<Boolean>, Boolean, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to add a boolean to a list if a condition is met
addToList(List<Integer>, Integer, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to add an integer to a list if a condition is met
addWeeks(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of weeks to a date returning a new object.
addWeeks(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of weeks to a date returning a new object.
addYears(int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of years to a date returning a new object.
addYears(Date, int) - Method in class com.frostdeveloper.api.FrostAPI: Adds a number of years to a date returning a new object.

C

clear() - Method in class com.frostdeveloper.api.core.Properties: Removes all the mappings from this map.
com.frostdeveloper.api - package com.frostdeveloper.api
com.frostdeveloper.api.core - package com.frostdeveloper.api.core
com.frostdeveloper.api.utility - package com.frostdeveloper.api.utility
ConsoleColor - Enum in com.frostdeveloper.api.utility: A class used to create methods to get instance of console colors.
containsKey(Object) - Method in class com.frostdeveloper.api.core.Properties: Tests if the specified object is a key in this table.
createParent(File) - Method in class com.frostdeveloper.api.FrostAPI: A method used to create all parent directories for a targeted file.

F

format(Date) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format a date to a pre-defined pattern
format(String, Date) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format a date to a specific pattern
format(String, Object...) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format a method to include an array of parameters in the message using a number format variable (i.e {0}).
format(boolean, String, Object...) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format a string and translate Bukkit color codes
format(ConsoleColor, String, Object...) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
format(boolean, ConsoleColor, String, Object...) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
format(Level, String, Object...) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
format(boolean, Level, String, Object...) - Method in class com.frostdeveloper.api.FrostAPI: A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
FrostAPI - Class in com.frostdeveloper.api
FrostAPI() - Constructor for class com.frostdeveloper.api.FrostAPI

G

getExtension(String, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a string representation of a file path.
getExtension(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a string representation of a file path
getExtension(File, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a file path, Additionally define whether the extension should contain its '.' character.
getExtension(File) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a file path
getExtension(Path, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a file path, Additionally define whether the extension should contain its '.' character.
getExtension(Path) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a file path
getInstance() - Static method in class com.frostdeveloper.api.FrostAPI: A method used to return an instance of this api class
getLevenshteinDistance(String, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return the LevenshteinDistance between two string, this method will return and integer that tells you how much of a difference there is between two strings.
getProperty(String) - Method in class com.frostdeveloper.api.core.Properties: A method used to search for a specific property key inside our property list, If the key is not found, this method will return null
getProperty(String, Object) - Method in class com.frostdeveloper.api.core.Properties: A method used to search for a specific property key inside our property list, If the key is not found, this method will return the specified default property value.
getToday() - Method in class com.frostdeveloper.api.FrostAPI: A method used to return the current time
getTodayAsString() - Method in class com.frostdeveloper.api.FrostAPI: A method used to return the current date and time as a string
getTodayAsString(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return the current date and time as a string

I

isAfterDate(String, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to test whether a date is after a different date.
isAfterDate(Date, Date) - Method in class com.frostdeveloper.api.FrostAPI: A method used to test whether a date is after a different date.
isBeforeDate(String, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to test whether a date is before a different date.
isBeforeDate(String, Date) - Method in class com.frostdeveloper.api.FrostAPI: A method used to test whether a date is before a different date.
isBeforeDate(Date, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to test whether a date is before a different date.
isBeforeDate(Date, Date) - Method in class com.frostdeveloper.api.FrostAPI: A method used to test whether a date is before a different date.
isEmpty() - Method in class com.frostdeveloper.api.core.Properties: Returns true if this map contains no key-value mappings.
isOrdered() - Method in class com.frostdeveloper.api.core.Properties: A method used to return whether a properties are to be in alphabetical order.

L

load(File) - Method in class com.frostdeveloper.api.core.Properties: A method used to read a property list (keys and element pairs).
load(InputStream) - Method in class com.frostdeveloper.api.core.Properties: A method used to read a property list (keys and element pairs).

M

matchString(Object[], String, double) - Method in class com.frostdeveloper.api.FrostAPI: A method used to find the closest matching string from inside an array, This method uses the LevenshteinDistance class to return this outcome.
matchString(List<String>, String, double) - Method in class com.frostdeveloper.api.FrostAPI: A method used to find the closest matching string from inside a list, This method uses the LevenshteinDistance class to return this outcome.
matchString(Object, String, double) - Method in class com.frostdeveloper.api.FrostAPI: A method used to find the closest matching string from a value, This method uses the LevenshteinDistance class to return this outcome.
matchString(List<String>, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to find the closest matching string from inside a list, This method uses the LevenshteinDistance class to return this outcome.
matchString(Object[], String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to find the closest matching string from inside an array, This method uses the LevenshteinDistance class to return this outcome.
matchString(Object, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to find the closest matching string from a value, This method uses the LevenshteinDistance class to return this outcome.

P

parseDate(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to convert a string to a valid date.
parseTime(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to turn a string into a valid time, and calculate the amount required.
Properties - Class in com.frostdeveloper.api.core: The Properties class is designed to add new methods not seen in the Properties class, makes using properties files much easier and extends Javas properties capabilities.
Properties() - Constructor for class com.frostdeveloper.api.core.Properties: Creates a new property list with no default values.
Properties(boolean) - Constructor for class com.frostdeveloper.api.core.Properties: Creates a new property list with no default values.

R

relocateIndex(File, File) - Method in class com.frostdeveloper.api.FrostAPI: A method used to relocate an index to a new location
remove(String) - Static method in enum com.frostdeveloper.api.utility.ConsoleColor: A method used to remove an enum color from an input, if not color was found this method will return the unchanged original string.
removeProperty(String) - Method in class com.frostdeveloper.api.core.Properties: A method used to remove a property from a properties map.
renameIndex(File, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to rename an index
renameParent(File, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to rename the parent directory of an index.

S

setProperty(String, Object) - Method in class com.frostdeveloper.api.core.Properties: A method used to set a value to a property inside our property list if it does not already exist.
setProperty(String, Object, boolean) - Method in class com.frostdeveloper.api.core.Properties: A method used to set a value to a property inside our property list if it does not already exist.
store(File, String) - Method in class com.frostdeveloper.api.core.Properties: A method used to write our properties list (keys and element pairs), in a format suitable for property loading.
store(File) - Method in class com.frostdeveloper.api.core.Properties: A method used to write our properties list (keys and element pairs), in a format suitable for property loading.
stringPropertyNames() - Method in class com.frostdeveloper.api.core.Properties: A method used to return a set of string property names for a property map.
stripColor(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to strip color codes from an input, it will remove any color codes present.
stripColor(List<String>) - Method in class com.frostdeveloper.api.FrostAPI: A method used to remove color codes from any given string list this method will iterate through the list and individually remove color codes.
stripColor(String[]) - Method in class com.frostdeveloper.api.FrostAPI: A method used to remove color codes from any given string list this method will iterate through the list and individually remove color codes.

T

toBoolean(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return an object as a boolean
toDay(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used in a runnable.
toDouble(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return an object as a double
toFile(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to create a file object from a string path.
toFile(Path) - Method in class com.frostdeveloper.api.FrostAPI: A method used to create a file object from a path.
toFile(File, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to create a file object from a string path.
toHour(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used in a runnable.
toInteger(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return an object as an integer
toLocale(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to convert a string into a usable locale, this method pairs with the Apache Commons library to convert the string.
toMinute(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used in a runnable.
toSecond(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used in a runnable.
toString(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return an object as a string
toString() - Method in enum com.frostdeveloper.api.utility.ConsoleColor: A method used to get the color code for a console color

V

valueOf(String) - Static method in enum com.frostdeveloper.api.utility.ConsoleColor: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.frostdeveloper.api.utility.ConsoleColor: Returns an array containing the constants of this enum type, in the order they are declared.

A C F G I L M P R S T V