FrostAPI (FrostAPI 1.3.2 API)

java.lang.Object
- com.frostdeveloper.api.FrostAPI

```
public class FrostAPI
extends Object
```

Constructor Summary

Constructors
Constructor and Description

FrostAPI()

Constructors
Constructor and Description
`FrostAPI()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`addDays(Date date, int amount)` Adds a number of days to a date returning a new object.
`Date`	`addDays(int amount)` Adds a number of days to a date returning a new object.
`Date`	`addHours(Date date, int amount)` Adds a number of hours to a date returning a new object.
`Date`	`addHours(int amount)` Adds a number of hours to a date returning a new object.
`Date`	`addMilliseconds(Date date, int amount)` Adds a number of milliseconds to a date returning a new object.
`Date`	`addMilliseconds(int amount)` Adds a number of milliseconds to a date returning a new object.
`Date`	`addMinutes(Date date, int amount)` Adds a number of minutes to a date returning a new object.
`Date`	`addMinutes(int amount)` Adds a number of minutes to a date returning a new object.
`Date`	`addMonths(Date date, int amount)` Adds a number of months to a date returning a new object.
`Date`	`addMonths(int amount)` Adds a number of months to a date returning a new object.
`Date`	`addSeconds(Date date, int amount)` Adds a number of seconds to a date returning a new object.
`Date`	`addSeconds(int amount)` Adds a number of seconds to a date returning a new object.
`Date`	`addTime(@NotNull String input)` 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.
`void`	`addToList(List<Boolean> list, Boolean value, boolean condition)` A method used to add a boolean to a list if a condition is met
`void`	`addToList(List<Integer> list, Integer value, boolean condition)` A method used to add an integer to a list if a condition is met
`void`	`addToList(List<Object> list, Object value, boolean condition)` A method used to add an object to a list if a condition is met
`void`	`addToList(List<String> list, String value, boolean condition)` A method used to add a string to a list if a condition is met
`Date`	`addWeeks(Date date, int amount)` Adds a number of weeks to a date returning a new object.
`Date`	`addWeeks(int amount)` Adds a number of weeks to a date returning a new object.
`Date`	`addYears(Date date, int amount)` Adds a number of years to a date returning a new object.
`Date`	`addYears(int amount)` Adds a number of years to a date returning a new object.
`void`	`createParent(@NotNull File target)` A method used to create all parent directories for a targeted file.
`String`	`format(boolean stripColor, ConsoleColor color, String input, Object... param)` A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
`String`	`format(boolean stripColor, @NotNull Level level, String input, Object... param)` A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
`@NotNull String`	`format(boolean stripColor, String input, Object... param)` A method used to format a string and translate Bukkit color codes
`String`	`format(ConsoleColor color, String input, Object... param)` A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
`String`	`format(Date date)` A method used to format a date to a pre-defined pattern
`String`	`format(Level level, String input, Object... param)` A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
`String`	`format(String pattern, Date date)` A method used to format a date to a specific pattern
`@NotNull String`	`format(String input, Object... param)` A method used to format a method to include an array of parameters in the message using a number format variable (i.e {0}).
`String`	`getExtension(File target)` A method used to get the file extension from a file path
`String`	`getExtension(@NotNull File target, boolean dotless)` A method used to get the file extension from a file path, Additionally define whether the extension should contain its '.' character.
`String`	`getExtension(Path path)` A method used to get the file extension from a file path
`String`	`getExtension(@NotNull Path path, boolean dotless)` A method used to get the file extension from a file path, Additionally define whether the extension should contain its '.' character.
`String`	`getExtension(String path)` A method used to get the file extension from a string representation of a file path
`String`	`getExtension(@NotNull String path, boolean dotless)` A method used to get the file extension from a string representation of a file path.
`static @NotNull FrostAPI`	`getInstance()` A method used to return an instance of this api class
`int`	`getLevenshteinDistance(@NotNull String input, @NotNull String compared)` 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.
`Date`	`getToday()` A method used to return the current time
`String`	`getTodayAsString()` A method used to return the current date and time as a string
`String`	`getTodayAsString(String pattern)` A method used to return the current date and time as a string
`boolean`	`isAfterDate(@NotNull Date target, Date comparedTo)` A method used to test whether a date is after a different date.
`boolean`	`isAfterDate(String target, String comparedTo)` A method used to test whether a date is after a different date.
`boolean`	`isBeforeDate(@NotNull Date target, Date comparedTo)` A method used to test whether a date is before a different date.
`boolean`	`isBeforeDate(Date target, String comparedTo)` A method used to test whether a date is before a different date.
`boolean`	`isBeforeDate(String target, Date comparedTo)` A method used to test whether a date is before a different date.
`boolean`	`isBeforeDate(String target, String comparedTo)` A method used to test whether a date is before a different date.
`String`	`matchString(List<String> values, String input)` A method used to find the closest matching string from inside a list, This method uses the `LevenshteinDistance` class to return this outcome.
`String`	`matchString(@NotNull List<String> values, String input, double threshold)` A method used to find the closest matching string from inside a list, This method uses the `LevenshteinDistance` class to return this outcome.
`String`	`matchString(Object[] values, String input)` A method used to find the closest matching string from inside an array, This method uses the `LevenshteinDistance` class to return this outcome.
`String`	`matchString(Object[] values, String input, double threshold)` A method used to find the closest matching string from inside an array, This method uses the `LevenshteinDistance` class to return this outcome.
`String`	`matchString(Object value, String input)` A method used to find the closest matching string from a value, This method uses the `LevenshteinDistance` class to return this outcome.
`String`	`matchString(Object value, String input, double threshold)` A method used to find the closest matching string from a value, This method uses the `LevenshteinDistance` class to return this outcome.
`Date`	`parseDate(String input)` A method used to convert a string to a valid date.
`int`	`parseTime(@NotNull String input)` A method used to turn a string into a valid time, and calculate the amount required.
`void`	`relocateIndex(File target, File location)` A method used to relocate an index to a new location
`void`	`renameIndex(File target, String name)` A method used to rename an index
`void`	`renameParent(@NotNull File target, String name)` A method used to rename the parent directory of an index.
`@NotNull List<String>`	`stripColor(@NotNull List<String> input)` A method used to remove color codes from any given string list this method will iterate through the list and individually remove color codes.
`String`	`stripColor(String input)` A method used to strip color codes from an input, it will remove any color codes present.
`@NotNull String[]`	`stripColor(@NotNull String[] input)` A method used to remove color codes from any given string list this method will iterate through the list and individually remove color codes.
`boolean`	`toBoolean(Object target)` A method used to return an object as a boolean
`int`	`toDay(Object amount)` A method used in a runnable.
`double`	`toDouble(Object target)` A method used to return an object as a double
`File`	`toFile(File parent, @NotNull String path)` A method used to create a file object from a string path.
`File`	`toFile(Path path)` A method used to create a file object from a path.
`File`	`toFile(String path)` A method used to create a file object from a string path.
`int`	`toHour(Object amount)` A method used in a runnable.
`int`	`toInteger(Object target)` A method used to return an object as an integer
`Locale`	`toLocale(@NotNull String target)` A method used to convert a string into a usable locale, this method pairs with the Apache Commons library to convert the string.
`int`	`toMinute(Object amount)` A method used in a runnable.
`int`	`toSecond(Object amount)` A method used in a runnable.
`String`	`toString(Object target)` A method used to return an object as a string

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FrostAPI
```
public FrostAPI()
```
- Method Detail
  - getInstance
```
@NotNull
public static @NotNull FrostAPI getInstance()
```
    A method used to return an instance of this api class
    
    Returns:
    
    API instance
    
    Since:
    
    1.0.0
  - createParent
```
public void createParent(@NotNull
                         @NotNull File target)
```
    A method used to create all parent directories for a targeted file.
    
    Parameters:
    
    target - The file path
    
    Since:
    
    1.0.0
  - renameParent
```
public void renameParent(@NotNull
                         @NotNull File target,
                         String name)
```
    A method used to rename the parent directory of an index.
    
    Parameters:
    
    target - Target file
    
    name - New parent name
    
    Since:
    
    1.0.0
  - renameIndex
```
public void renameIndex(File target,
                        String name)
```
    A method used to rename an index
    
    Parameters:
    
    target - Target file
    
    name - New name
    
    Since:
    
    1.0.0
  - relocateIndex
```
public void relocateIndex(File target,
                          File location)
```
    A method used to relocate an index to a new location
    
    Parameters:
    
    target - Target index
    
    location - Desired Location
    
    Since:
    
    1.1.0
  - toFile
```
public File toFile(String path)
```
    A method used to create a file object from a string path.
    
    Parameters:
    
    path - Target path
    
    Returns:
    
    File object from a string path
    
    Since:
    
    1.0.0
  - toFile
```
public File toFile(Path path)
```
    A method used to create a file object from a path.
    
    Parameters:
    
    path - Target path
    
    Returns:
    
    File object from a string path
    
    Since:
    
    1.0.0
  - toFile
```
public File toFile(File parent,
                   @NotNull
                   @NotNull String path)
```
    A method used to create a file object from a string path. This method also allows you to define the starting point of the path, from a parent directory
    
    Parameters:
    
    parent - The starting point to the path.
    
    path - Target path
    
    Returns:
    
    File object from a string path
    
    Since:
    
    1.0.0
  - toString
```
public String toString(Object target)
```
    A method used to return an object as a string
    
    Parameters:
    
    target - Target object
    
    Returns:
    
    An object as a string
    
    Since:
    
    1.0.0
  - toBoolean
```
public boolean toBoolean(Object target)
```
    A method used to return an object as a boolean
    
    Parameters:
    
    target - Target object
    
    Returns:
    
    An object as a boolean
    
    Since:
    
    1.0.0
  - toInteger
```
public int toInteger(Object target)
```
    A method used to return an object as an integer
    
    Parameters:
    
    target - Target object
    
    Returns:
    
    An object as an integer
    
    Since:
    
    1.0.0
  - toDouble
```
public double toDouble(Object target)
```
    A method used to return an object as a double
    
    Parameters:
    
    target - Target object
    
    Returns:
    
    An object as a double
    
    Since:
    
    1.0.0
  - toLocale
```
public Locale toLocale(@NotNull
                       @NotNull String target)
```
    A method used to convert a string into a usable locale, this method pairs with the Apache Commons library to convert the string. This method will correct
    
    Parameters:
    
    target - Targeted input
    
    Returns:
    
    A valid locale type
    
    Since:
    
    1.0.0
  - getToday
```
public Date getToday()
```
    A method used to return the current time
    
    Returns:
    
    Current Time
    
    Since:
    
    1.0.0
  - getTodayAsString
```
public String getTodayAsString()
```
    A method used to return the current date and time as a string
    
    Returns:
    
    A string representing the current date.
    
    Since:
    
    1.0.0
  - getTodayAsString
```
public String getTodayAsString(String pattern)
```
    A method used to return the current date and time as a string
    
    Parameters:
    
    pattern - Date pattern
    
    Returns:
    
    A string representing the current date.
    
    Since:
    
    1.0.0
  - toSecond
```
public int toSecond(Object amount)
```
    A method used in a runnable. It's used to return the amount of time required to complete the delay in seconds
    
    Parameters:
    
    amount - Amount of seconds.
    
    Returns:
    
    Delay in seconds
    
    Since:
    
    1.0.0
  - toMinute
```
public int toMinute(Object amount)
```
    A method used in a runnable. It's used to return the amount of time required to complete the delay in minutes
    
    Parameters:
    
    amount - Amount of minutes.
    
    Returns:
    
    Delay in minutes
    
    Since:
    
    1.0.0
  - toHour
```
public int toHour(Object amount)
```
    A method used in a runnable. It's used to return the amount of time required to complete the delay in hours
    
    Parameters:
    
    amount - Amount of hours.
    
    Returns:
    
    Delay in hours
    
    Since:
    
    1.0.0
  - toDay
```
public int toDay(Object amount)
```
    A method used in a runnable. It's used to return the amount of time required to complete the delay in days
    
    Parameters:
    
    amount - Amount of days.
    
    Returns:
    
    Delay in days
    
    Since:
    
    1.0.0
  - parseTime
```
public int parseTime(@NotNull
                     @NotNull String input)
```
    A method used to turn a string into a valid time, and calculate the amount required.
    
    Parameters:
    
    input - String input
    
    Returns:
    
    Requested duration
    
    Since:
    
    1.0.0
  - parseDate
```
public Date parseDate(String input)
```
    A method used to convert a string to a valid date.
    
    Parameters:
    
    input - String representation of a date.
    
    Returns:
    
    A date object.
    
    Since:
    
    1.1.0
  - addYears
```
public Date addYears(int amount)
```
    Adds a number of years to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addYears
```
public Date addYears(Date date,
                     int amount)
```
    Adds a number of years to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addMonths
```
public Date addMonths(int amount)
```
    Adds a number of months to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addMonths
```
public Date addMonths(Date date,
                      int amount)
```
    Adds a number of months to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addWeeks
```
public Date addWeeks(int amount)
```
    Adds a number of weeks to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addWeeks
```
public Date addWeeks(Date date,
                     int amount)
```
    Adds a number of weeks to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addDays
```
public Date addDays(int amount)
```
    Adds a number of days to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addDays
```
public Date addDays(Date date,
                    int amount)
```
    Adds a number of days to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addHours
```
public Date addHours(int amount)
```
    Adds a number of hours to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addHours
```
public Date addHours(Date date,
                     int amount)
```
    Adds a number of hours to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addMinutes
```
public Date addMinutes(int amount)
```
    Adds a number of minutes to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addMinutes
```
public Date addMinutes(Date date,
                       int amount)
```
    Adds a number of minutes to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addSeconds
```
public Date addSeconds(int amount)
```
    Adds a number of seconds to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addSeconds
```
public Date addSeconds(Date date,
                       int amount)
```
    Adds a number of seconds to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addMilliseconds
```
public Date addMilliseconds(int amount)
```
    Adds a number of milliseconds to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addMilliseconds
```
public Date addMilliseconds(Date date,
                            int amount)
```
    Adds a number of milliseconds to a date returning a new object. The original Date is unchanged.
    
    Parameters:
    
    date - the date, not null
    
    amount - the amount to add, may be negative
    
    Returns:
    
    the new Date with the amount added
    
    Throws:
    
    IllegalArgumentException - if the date is null
  - addTime
```
public Date addTime(@NotNull
                    @NotNull String input)
```
    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. If an invalid string is given, this method will always return the current date.
    
    Parameters:
    
    input - Target time
    
    Returns:
    
    New date with added time
  - isBeforeDate
```
public boolean isBeforeDate(String target,
                            String comparedTo)
```
    A method used to test whether a date is before a different date.
    
    Parameters:
    
    target - The date being tested.
    
    comparedTo - The date you will compare the target to.
    
    Returns:
    
    Whether the target date is before the compared date.
    
    Since:
    
    1.1.0
  - isBeforeDate
```
public boolean isBeforeDate(String target,
                            Date comparedTo)
```
    A method used to test whether a date is before a different date.
    
    Parameters:
    
    target - The date being tested.
    
    comparedTo - The date you will compare the target to.
    
    Returns:
    
    Whether the target date is before the compared date.
    
    Since:
    
    1.2.0
  - isBeforeDate
```
public boolean isBeforeDate(Date target,
                            String comparedTo)
```
    A method used to test whether a date is before a different date.
    
    Parameters:
    
    target - The date being tested.
    
    comparedTo - The date you will compare the target to.
    
    Returns:
    
    Whether the target date is before the compared date.
    
    Since:
    
    1.2.0
  - isBeforeDate
```
public boolean isBeforeDate(@NotNull
                            @NotNull Date target,
                            Date comparedTo)
```
    A method used to test whether a date is before a different date.
    
    Parameters:
    
    target - The date being tested.
    
    comparedTo - The date you will compare the target to.
    
    Returns:
    
    Whether the target date is before the compared date.
    
    Since:
    
    1.1.0
  - isAfterDate
```
public boolean isAfterDate(String target,
                           String comparedTo)
```
    A method used to test whether a date is after a different date.
    
    Parameters:
    
    target - The date being tested.
    
    comparedTo - The date you will compare the target to.
    
    Returns:
    
    Whether the target date is after the compared date.
    
    Since:
    
    1.1.0
  - isAfterDate
```
public boolean isAfterDate(@NotNull
                           @NotNull Date target,
                           Date comparedTo)
```
    A method used to test whether a date is after a different date.
    
    Parameters:
    
    target - The date being tested.
    
    comparedTo - The date you will compare the target to.
    
    Returns:
    
    Whether the target date is after the compared date.
    
    Since:
    
    1.1.0
  - getExtension
```
public String getExtension(@NotNull
                           @NotNull String path,
                           boolean dotless)
```
    A method used to get the file extension from a string representation of a file path. Additionally define whether the extension should contain its '.' character.
    
    Parameters:
    
    path - String representation of file path
    
    dotless - Whether our return value should contain a '.' character
    
    Returns:
    
    File extension
    
    Since:
    
    1.0.0
  - getExtension
```
public String getExtension(String path)
```
    A method used to get the file extension from a string representation of a file path
    
    Parameters:
    
    path - String representation of file path
    
    Returns:
    
    File extension
    
    Since:
    
    1.0.0
  - getExtension
```
public String getExtension(@NotNull
                           @NotNull File target,
                           boolean dotless)
```
    A method used to get the file extension from a file path, Additionally define whether the extension should contain its '.' character.
    
    Parameters:
    
    target - File path
    
    dotless - Whether our return value should contain a '.' character
    
    Returns:
    
    File extension
    
    Since:
    
    1.0.0
  - getExtension
```
public String getExtension(File target)
```
    A method used to get the file extension from a file path
    
    Parameters:
    
    target - File path
    
    Returns:
    
    File extension
    
    Since:
    
    1.0.0
  - getExtension
```
public String getExtension(@NotNull
                           @NotNull Path path,
                           boolean dotless)
```
    A method used to get the file extension from a file path, Additionally define whether the extension should contain its '.' character.
    
    Parameters:
    
    path - File path
    
    dotless - Whether our return value should contain a '.' character
    
    Returns:
    
    File extension
    
    Since:
    
    1.0.0
  - getExtension
```
public String getExtension(Path path)
```
    A method used to get the file extension from a file path
    
    Parameters:
    
    path - File path
    
    Returns:
    
    File extension
    
    Since:
    
    1.0.0
  - format
```
public String format(Date date)
```
    A method used to format a date to a pre-defined pattern
    
    Parameters:
    
    date - Target date
    
    Returns:
    
    Formatted date
    
    Since:
    
    1.0.0
  - format
```
public String format(String pattern,
                     Date date)
```
    A method used to format a date to a specific pattern
    
    Parameters:
    
    pattern - Desired pattern
    
    date - Target date
    
    Returns:
    
    Formatted date
    
    Since:
    
    1.0.0
  - format
```
@NotNull
public @NotNull String format(String input,
                                       Object... param)
```
    A method used to format a method to include an array of parameters in the message using a number format variable (i.e {0}).
    
    Parameters:
    
    input - Target message
    
    param - Optional params
    
    Returns:
    
    Formatted message
    
    Since:
    
    1.0.0
  - format
```
@NotNull
public @NotNull String format(boolean stripColor,
                                       String input,
                                       Object... param)
```
    A method used to format a string and translate Bukkit color codes
    
    Parameters:
    
    stripColor - Condition to strip color codes
    
    input - Target message
    
    param - Optional params
    
    Returns:
    
    Formatted message
    
    Since:
    
    1.0.0
  - format
```
public String format(ConsoleColor color,
                     String input,
                     Object... param)
```
    A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
    
    Parameters:
    
    color - Target color
    
    input - Target message
    
    param - Optional params
    
    Returns:
    
    Formatted message
    
    Since:
    
    1.1.0
  - format
```
public String format(boolean stripColor,
                     ConsoleColor color,
                     String input,
                     Object... param)
```
    A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
    
    Parameters:
    
    stripColor - Strip color codes within the input
    
    color - Target color
    
    input - Target message
    
    param - Optional params
    
    Returns:
    
    Formatted message
    
    Since:
    
    1.2.6
  - format
```
public String format(Level level,
                     String input,
                     Object... param)
```
    A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
    
    Parameters:
    
    level - Level of severity
    
    input - Target message
    
    param - Optional params
    
    Returns:
    
    Formatted message
    
    Since:
    
    1.2.6
  - format
```
public String format(boolean stripColor,
                     @NotNull
                     @NotNull Level level,
                     String input,
                     Object... param)
```
    A method used to format our console colors into the specified input, this method includes the ability to add parameters by default.
    
    Parameters:
    
    stripColor - Strip color codes within the input
    
    level - Level of severity
    
    input - Target message
    
    param - Optional params
    
    Returns:
    
    Formatted message
    
    Since:
    
    1.2.6
  - stripColor
```
public String stripColor(String input)
```
    A method used to strip color codes from an input, it will remove any color codes present.
    
    Parameters:
    
    input - Target input
    
    Returns:
    
    Colorless output.
    
    Since:
    
    1.0.0
  - stripColor
```
@NotNull
public @NotNull List<String> stripColor(@NotNull
                                                 @NotNull List<String> input)
```
    A method used to remove color codes from any given string list this method will iterate through the list and individually remove color codes.
    
    Parameters:
    
    input - Target list
    
    Returns:
    
    Colorless list.
    
    Since:
    
    1.0.0
  - stripColor
```
@NotNull
public @NotNull String[] stripColor(@NotNull
                                             @NotNull String[] input)
```
    A method used to remove color codes from any given string list this method will iterate through the list and individually remove color codes.
    
    Parameters:
    
    input - Target array
    
    Returns:
    
    Colorless array.
    
    Since:
    
    1.0.0
  - addToList
```
public void addToList(List<String> list,
                      String value,
                      boolean condition)
```
    A method used to add a string to a list if a condition is met
    
    Parameters:
    
    list - Target list
    
    value - Target value
    
    condition - Required condition
    
    Since:
    
    1.1.0
  - addToList
```
public void addToList(List<Object> list,
                      Object value,
                      boolean condition)
```
    A method used to add an object to a list if a condition is met
    
    Parameters:
    
    list - Target list
    
    value - Target value
    
    condition - Required condition
    
    Since:
    
    1.1.0
  - addToList
```
public void addToList(List<Boolean> list,
                      Boolean value,
                      boolean condition)
```
    A method used to add a boolean to a list if a condition is met
    
    Parameters:
    
    list - Target list
    
    value - Target value
    
    condition - Required condition
    
    Since:
    
    1.1.0
  - addToList
```
public void addToList(List<Integer> list,
                      Integer value,
                      boolean condition)
```
    A method used to add an integer to a list if a condition is met
    
    Parameters:
    
    list - Target list
    
    value - Target value
    
    condition - Required condition
    
    Since:
    
    1.1.0
  - matchString
```
public String matchString(Object[] values,
                          String input,
                          double threshold)
```
    A method used to find the closest matching string from inside an array, This method uses the LevenshteinDistance class to return this outcome. If a match cannot be determined, this method will return null.
    
    Parameters:
    
    values - Tested array
    
    input - Input being compared
    
    threshold - Minimum percentage the input needs to match
    
    Returns:
    
    Closes match to input
    
    Since:
    
    1.2.6
  - matchString
```
public String matchString(@NotNull
                          @NotNull List<String> values,
                          String input,
                          double threshold)
```
    A method used to find the closest matching string from inside a list, This method uses the LevenshteinDistance class to return this outcome. If a match cannot be determined, this method will return null.
    
    Parameters:
    
    values - Tested list
    
    input - Input being compared
    
    threshold - Minimum percentage the input needs to match
    
    Returns:
    
    Closes match to input
    
    Since:
    
    1.2.6
  - matchString
```
public String matchString(Object value,
                          String input,
                          double threshold)
```
    A method used to find the closest matching string from a value, This method uses the LevenshteinDistance class to return this outcome. If a match cannot be determined, this method will return null.
    
    Parameters:
    
    value - Tested value
    
    input - Input being compared
    
    threshold - Minimum percentage the input needs to match
    
    Returns:
    
    Closes match to input
    
    Since:
    
    1.3.0
  - matchString
```
public String matchString(List<String> values,
                          String input)
```
    A method used to find the closest matching string from inside a list, This method uses the LevenshteinDistance class to return this outcome. If a match cannot be determined, this method will return null.
    
    Parameters:
    
    values - Tested list
    
    input - Input being compared
    
    Returns:
    
    Closes match to input
    
    Since:
    
    1.2.6
  - matchString
```
public String matchString(Object[] values,
                          String input)
```
    A method used to find the closest matching string from inside an array, This method uses the LevenshteinDistance class to return this outcome. If a match cannot be determined, this method will return null.
    
    Parameters:
    
    values - Tested array
    
    input - Input being compared
    
    Returns:
    
    Closes match to input
    
    Since:
    
    1.2.6
  - matchString
```
public String matchString(Object value,
                          String input)
```
    A method used to find the closest matching string from a value, This method uses the LevenshteinDistance class to return this outcome. If a match cannot be determined, this method will return null.
    
    Parameters:
    
    value - Tested value
    
    input - Input being compared
    
    Returns:
    
    Closes match to input
    
    Since:
    
    1.3.0
  - getLevenshteinDistance
```
public int getLevenshteinDistance(@NotNull
                                  @NotNull String input,
                                  @NotNull
                                  @NotNull String compared)
```
    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.
    
    For example, if you are comparing your input "Hello" and you are testing the distance from "Hello World", this method will return 6 because there are 6 characters between the closest matching string.
    
    Parameters:
    
    input - The working input
    
    compared - The target comparison
    
    Returns:
    
    The distance between matches
    
    Since:
    
    1.2.6

Class FrostAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FrostAPI

Method Detail

getInstance

createParent

renameParent

renameIndex

relocateIndex

toFile

toFile

toFile

toString

toBoolean

toInteger

toDouble

toLocale

getToday

getTodayAsString

getTodayAsString

toSecond

toMinute

toHour

toDay

parseTime

parseDate

addYears

addYears

addMonths

addMonths

addWeeks

addWeeks

addDays

addDays

addHours

addHours

addMinutes

addMinutes

addSeconds

addSeconds

addMilliseconds

addMilliseconds

addTime

isBeforeDate

isBeforeDate

isBeforeDate

isBeforeDate

isAfterDate

isAfterDate

getExtension

getExtension

getExtension

getExtension

getExtension

getExtension

format

format

format

format

format

format

format

format

stripColor

stripColor

stripColor

addToList

addToList

addToList

addToList

matchString

matchString

matchString

matchString

matchString

matchString

getLevenshteinDistance