Index (FrostAPI 1.2.2 API)

A C F G I K L N 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.
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
allFalse(boolean...) - Static method in class com.frostdeveloper.api.FrostAPI: A method used to test the conditions and will return true if all conditions are false.
allTrue(boolean...) - Static method in class com.frostdeveloper.api.FrostAPI: A method used to test the conditions and will return true if all conditions are true.
anyFalse(boolean...) - Static method in class com.frostdeveloper.api.FrostAPI: A method used to test the conditions and will return true if any of the conditions are false.
anyTrue(boolean...) - Static method in class com.frostdeveloper.api.FrostAPI: A method used to test the conditions and will return true if any of the conditions are true.

C

clear() - Method in class com.frostdeveloper.api.core.Properties: Clears this hashtable so that it contains no keys.
com.frostdeveloper.api - package com.frostdeveloper.api
com.frostdeveloper.api.core - package com.frostdeveloper.api.core
com.frostdeveloper.api.exception - package com.frostdeveloper.api.exception
com.frostdeveloper.api.handler - package com.frostdeveloper.api.handler
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.
create(Throwable, boolean) - Method in class com.frostdeveloper.api.handler.Report: A method used to create our report with an option to specify if the stacktrace should be silent.
create(Throwable) - Method in class com.frostdeveloper.api.handler.Report: A method used to create our report.
createParent(File) - Method in class com.frostdeveloper.api.FrostAPI: A method used to create all parent directories for a targeted file.

F

FailedMethodException - Exception in com.frostdeveloper.api.exception: An exception used when a method failed to execute its code correctly.
FailedMethodException() - Constructor for exception com.frostdeveloper.api.exception.FailedMethodException: An exception caught when a method failed to execute correctly.
FailedMethodException(String) - Constructor for exception com.frostdeveloper.api.exception.FailedMethodException: An exception caught when a method failed to execute correctly.
FailedMethodException(String, Throwable) - Constructor for exception com.frostdeveloper.api.exception.FailedMethodException: An exception caught when a method failed to execute correctly.
FailedMethodException(String, Object...) - Constructor for exception com.frostdeveloper.api.exception.FailedMethodException: An exception caught when a method failed to execute correctly.
FailedMethodException(String, Throwable, Object...) - Constructor for exception com.frostdeveloper.api.exception.FailedMethodException: An exception caught when a method failed to execute correctly.
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.
FrostAPI - Class in com.frostdeveloper.api: A class used to house redundant methods used across multiple projects, this plugin is designed to make development easier for all current and future projects.
FrostAPI() - Constructor for class com.frostdeveloper.api.FrostAPI

G

getCreatedDate(File) - Method in class com.frostdeveloper.api.FrostAPI: This method is used to get the date a file was created.
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) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a file path
getExtension(Path) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file extension from a file path
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(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(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.
getFileAttribute(File) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the attributes to a file.
getFileName(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file name in a path.
getFileName(Path) - Method in class com.frostdeveloper.api.FrostAPI: A method used to get the file name in a path.
getInstance() - Static method in class com.frostdeveloper.api.FrostAPI: A method used to return an instance of this api class
getLastAccessed(File) - Method in class com.frostdeveloper.api.FrostAPI: This method is used to get the date a file was last accessed.
getLastModified(File) - Method in class com.frostdeveloper.api.FrostAPI: This method is used to get the date a file was last modified.
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.
getResource(String) - Method in class com.frostdeveloper.api.FrostAPI: Returns an input stream for reading the specified resource.
getResourceURL(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return the url for a resource located in this .jar's resources file.
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.
isDirectory(File) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return whether an index is a directory or not.
isDirectory(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return whether an index path is a directory or not.
isDirectory(Path) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return whether an index path is a directory or not.
isEmpty() - Method in class com.frostdeveloper.api.core.Properties: Returns true if this map contains no key-value mappings.
isFalse(Object, String) - Static method in class com.frostdeveloper.api.handler.Validate: A method used to validate that an object is equal to false, if not this method will throw an exception with the specified message.
isFalse(Object) - Static method in class com.frostdeveloper.api.handler.Validate: A method used to validate that an object is equal to false, if not this method will throw an exception.
isFile(File) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return whether an index is a file or not.
isFile(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return whether an index path is a file or not.
isFile(Path) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return whether an index path is a file or not.
isOrdered() - Method in class com.frostdeveloper.api.core.Properties: A method used to return whether a properties are to be in alphabetical order.
isTrue(Object, String) - Static method in class com.frostdeveloper.api.handler.Validate: A method used to validate that an object is equal to true, if not this method will throw an exception with the specified message.
isTrue(Object) - Static method in class com.frostdeveloper.api.handler.Validate: A method used to validate that an object is equal to true, if not this method will throw an exception.

K

keys() - Method in class com.frostdeveloper.api.core.Properties: Returns an enumeration of the keys in this hashtable.
keySet() - Method in class com.frostdeveloper.api.core.Properties: Returns a Set view of the keys contained in this map.

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).

N

notNull(Object) - Static method in class com.frostdeveloper.api.handler.Validate: A method used to validate that an object is not null.
notNull(Object, String) - Static method in class com.frostdeveloper.api.handler.Validate: A method used to validate that an object is not null.
notNull(Object, String, Object...) - Static method in class com.frostdeveloper.api.handler.Validate: A method used to validate that an object is not null.

P

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.
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.
Report - Class in com.frostdeveloper.api.handler: A class used to handle exception reporting and logs our caught exception to a file.
Report(File) - Constructor for class com.frostdeveloper.api.handler.Report: A constructor used to establish our file output for our report log.
Report(String) - Constructor for class com.frostdeveloper.api.handler.Report: A constructor used to establish our file output for our report log.
Report(Path) - Constructor for class com.frostdeveloper.api.handler.Report: A constructor used to establish our file output for our report log.

S

saveResource(File, String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to save a resource from our resource file to a defined location.
saveResource(File, String, boolean) - Method in class com.frostdeveloper.api.FrostAPI: A method used to save a resource from our resource file to a defined location.
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.
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.

T

toBoolean(Object) - Method in class com.frostdeveloper.api.FrostAPI: A method used to return an object as a boolean
toDate(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to convert a string to a valid date.
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
toTime(String) - Method in class com.frostdeveloper.api.FrostAPI: A method used to turn a string into a valid time, and calculate the amount required.

V

Validate - Class in com.frostdeveloper.api.handler: A class used to house a variety of method that will validate objects throughout any project.
Validate() - Constructor for class com.frostdeveloper.api.handler.Validate
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 K L N P R S T V