goistreamtoolredux.algorithm

Class FileManager

java.lang.Object

goistreamtoolredux.algorithm.FileManager

public class FileManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	inputPath
static java.lang.String	outputPath

Constructor Summary

Constructors

Constructor and Description
FileManager()

Method Summary

Modifier and Type	Method and Description
static void	addTeam(java.lang.String fullName, java.lang.String shortName) Adds a team with no logo Updates teams.txt.
static void	addTeam(java.lang.String fullName, java.lang.String shortName, java.nio.file.Path image) Adds a team with no logo Updates teams.txt.
static void	checkForUpdates() checks GitHub for any new releases after current version.
static int	compareVersions(java.lang.String version1, java.lang.String version2) Returns 1 if v1 > v2, -1 otherwise
static boolean	convertFormat(java.lang.String inputImagePath, java.lang.String outputImagePath, java.lang.String formatName) Converts an image to another format
protected static java.nio.file.Path	findFile(java.util.LinkedList<java.nio.file.Path> allTeamImages, java.lang.String searchFor) Takes a list of Paths and finds a certain file by name, excluding extension
static java.util.LinkedList<java.lang.String>	getAllMapsFromDisk() Gets an updated list of maps from the maps.txt file
static java.lang.String	getDefaultInputPath() Gets the default (OS specific) application input folder path.
static java.lang.String	getDefaultOutputPath() Gets the default (OS specific) application output folder path.
static java.lang.String	getInputPath() Gets the currently set application input folder path.
static java.lang.String	getOutputPath() Gets the currently set application output folder path.
static void	getScsBracket(int number)
static java.lang.String	getShortName(java.lang.String longName) Parses `teams.txt` to get a team's longName from its shortName.
static java.lang.String	getTournamentName() Gets the current tournament name from file
static int	getTourneyNumber() Gets the current tournament number from file
static void	main(java.lang.String[] args)
static void	noInputFolderPrompt() Prompts user that input folder wasn't found.
static void	refreshPreferences() Attempts to refresh the application's preferences.
static void	removeMap() Remove the map image and name.
static void	removeTeam(java.lang.String teamIdentifier) Remove the currently set team from given team letter/identifier.
static void	resetInputPath() Resets the inputPath to application default
static void	resetOutputPath() Resets the outputPath to application default
static void	resetPreferences() Calls Preferences.clear() on the FileManager's preference node - effectively resetting it.
static void	setInputPath(java.lang.String inputPath) Sets the preferred input path
static boolean	setMap(java.lang.String mapName) Sets the current map.
static void	setMap(java.lang.String mapName, boolean isSpawn) Sets the current map, with or without spawn locations
static void	setOutputPath(java.lang.String outputPath) Sets the preferred output path
static void	setTeam(java.lang.String newTeamName, java.lang.String teamIdentifier) Sets the current team.
static void	setTournamentName(java.lang.String tournamentName) Updates the TournamentName.txt file.
static boolean	setTourneyNumber(java.lang.String number) Sets the current tournament number.
static void	verifyContent() Checks for input and output folders, creates them if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outputPath

public static java.lang.String outputPath

inputPath

public static java.lang.String inputPath

Constructor Detail

FileManager

public FileManager()

Method Detail

main

public static void main(java.lang.String[] args)

getOutputPath

public static java.lang.String getOutputPath()

Gets the currently set application output folder path.

Returns:

user preferred output folder, default if no preference is set

See Also:

getInputPath()

getDefaultOutputPath

public static java.lang.String getDefaultOutputPath()

Gets the default (OS specific) application output folder path. This should be the "Input" folder within "Documents" or documents equivalent on the user's OS. On non-MacOS Unix this will map to $HOME.

Returns:

full path to output folder ending with separator char (typically '/'), so that content may be appended to it

See Also:

getDefaultInputPath()

getInputPath

public static java.lang.String getInputPath()

Gets the currently set application input folder path.

Returns:

user preferred input folder, default if no preference is set

See Also:

getOutputPath()

getDefaultInputPath

public static java.lang.String getDefaultInputPath()

Gets the default (OS specific) application input folder path. This should be the "Input" folder within "Documents" or documents equivalent on the user's OS. On non-MacOS Unix this will map to $HOME.

Returns:

full path to input folder ending with separator char (typically '/'), so that content may be appended to it

See Also:

getDefaultOutputPath()

setOutputPath

public static void setOutputPath(java.lang.String outputPath)

Sets the preferred output path

Parameters:

outputPath - valid path to new output folder, MUST END IN FILE SEPARATOR

setInputPath

public static void setInputPath(java.lang.String inputPath)

Sets the preferred input path

Parameters:

inputPath - valid path to new input folder, MUST END IN FILE SEPARATOR

resetOutputPath

public static void resetOutputPath()

Resets the outputPath to application default

resetInputPath

public static void resetInputPath()

Resets the inputPath to application default

setTourneyNumber

public static boolean setTourneyNumber(java.lang.String number)

Sets the current tournament number.

Parameters:

number - new number representing current tournament

Returns:

false if IO operation failed

getTourneyNumber

public static int getTourneyNumber()
                            throws java.lang.NumberFormatException,
                                   java.io.FileNotFoundException

Gets the current tournament number from file

Returns:

current tournament number, or 1 if IO error encountered

Throws:

java.lang.NumberFormatException - if tournament file does not contain valid content

java.io.FileNotFoundException - TournamentNumber.txt could not be found

noInputFolderPrompt

public static void noInputFolderPrompt()

Prompts user that input folder wasn't found. Allows them to choose to download or open their own. Helper function for verifyContent()

verifyContent

public static void verifyContent()
                          throws java.io.IOException

Checks for input and output folders, creates them if necessary.

Throws:

java.io.IOException - Error creating file or directory

setTournamentName

public static void setTournamentName(java.lang.String tournamentName)
                              throws java.io.IOException

Updates the TournamentName.txt file.

Parameters:

tournamentName - new content for file

Throws:

java.io.IOException - if error writing to file

getTournamentName

public static java.lang.String getTournamentName()
                                          throws java.io.FileNotFoundException,
                                                 java.util.NoSuchElementException

Gets the current tournament name from file

Returns:

current tournament name

Throws:

java.io.FileNotFoundException - tournament file could not be found

java.util.NoSuchElementException - file contains unexpected (or no) content

setMap

public static boolean setMap(java.lang.String mapName)
                      throws java.io.IOException

Sets the current map.

Parameters:

mapName - Name of map to be set as current.

Returns:

false if map could not be updated (Doesnt exist, IO error). True otherwise.

Throws:

java.io.IOException - IO error for maps.txt opening or writing

java.io.FileNotFoundException - Likely error finding map file

setMap

public static void setMap(java.lang.String mapName,
                          boolean isSpawn)
                   throws java.io.IOException

Sets the current map, with or without spawn locations

Parameters:

mapName - Name of map to be set as current

isSpawn - If spawns should be shown on map or not

Throws:

java.io.IOException - IO error for maps.txt opening or writing

java.io.FileNotFoundException - Likely error finding map file

setTeam

public static void setTeam(java.lang.String newTeamName,
                           java.lang.String teamIdentifier)
                    throws java.io.IOException,
                           java.lang.IllegalArgumentException

Sets the current team. E.g., used when setting "The Skyborne" as team A. Updates the output teamA/B image with the new team's image. File is in the format "Team" + teamIdentifier + ".png" Updates the team & teamShort txt files to the new team's name. File name formatted as "Team" + teamIdentifier + ".txt", and "TeamShort" + teamIdentifier + ".txt"

Parameters:

newTeamName - Name of the team. Must occur in teams.txt

teamIdentifier - Value to identify team. Must be a valid character for filesystem

Throws:

java.io.IOException - error writing, reading, or converting files team files.

java.lang.IllegalArgumentException - Thrown if fcn args contain invalid characters or do not correspond to a team in teams.txt

addTeam

public static void addTeam(java.lang.String fullName,
                           java.lang.String shortName)
                    throws java.io.IOException

Adds a team with no logo Updates teams.txt.

Parameters:

fullName - full team name to add

shortName - short name of team, will be converted to caps

Throws:

java.io.IOException - IO on teams.txt failed.

addTeam

public static void addTeam(java.lang.String fullName,
                           java.lang.String shortName,
                           java.nio.file.Path image)
                    throws java.io.IOException

Adds a team with no logo Updates teams.txt.

Parameters:

fullName - full team name to add

shortName - short name of team, will be converted to caps

image - Path to image file which will be added to input folder

Throws:

java.io.IOException - file copy for image failed, or IO to teams.txt failed

java.io.FileNotFoundException - if the Path is a directory or extensionless file

findFile

protected static java.nio.file.Path findFile(java.util.LinkedList<java.nio.file.Path> allTeamImages,
                                             java.lang.String searchFor)

Takes a list of Paths and finds a certain file by name, excluding extension

Parameters:

allTeamImages - list of paths, all paths should be a file with an extension

Returns:

Path of found file

getShortName

public static java.lang.String getShortName(java.lang.String longName)
                                     throws java.io.FileNotFoundException

Parses `teams.txt` to get a team's longName from its shortName. Case insensitive search. Uppercase return. Can be used to verify the existence of a team by their full team name.

Parameters:

longName - longName to find corresponding shortName of

Returns:

Shortname, or null if no shortname can be found

Throws:

java.io.FileNotFoundException - teams.txt could not be found

convertFormat

public static boolean convertFormat(java.lang.String inputImagePath,
                                    java.lang.String outputImagePath,
                                    java.lang.String formatName)
                             throws java.io.IOException

Converts an image to another format

Parameters:

inputImagePath - Path of the source image

outputImagePath - Path of the destination image

formatName - the format to be converted to, one of: jpeg, png, bmp, wbmp, and gif

Returns:

true if successful, false otherwise

Throws:

java.io.IOException - if errors occur during writing

getAllMapsFromDisk

public static java.util.LinkedList<java.lang.String> getAllMapsFromDisk()
                                                                 throws java.io.FileNotFoundException

Gets an updated list of maps from the maps.txt file

Returns:

Each line of the maps.txt file, except empty lines

Throws:

java.io.FileNotFoundException - if maps.txt file was not found

getScsBracket

public static void getScsBracket(int number)

compareVersions

public static int compareVersions(java.lang.String version1,
                                  java.lang.String version2)

Returns 1 if v1 > v2, -1 otherwise

Parameters:

version1 -

version2 -

Returns:

checkForUpdates

public static void checkForUpdates()

checks GitHub for any new releases after current version. Takes user to download page if there is a new update.

resetPreferences

public static void resetPreferences()
                             throws java.util.prefs.BackingStoreException

Calls Preferences.clear() on the FileManager's preference node - effectively resetting it. Does not guarantee full refresh of preferences in app until after a restart.

Throws:

java.util.prefs.BackingStoreException - if could not complete clear due to failure relating to the backing store

refreshPreferences

public static void refreshPreferences()

Attempts to refresh the application's preferences.

removeTeam

public static void removeTeam(java.lang.String teamIdentifier)
                       throws java.io.IOException

Remove the currently set team from given team letter/identifier. Cancels out the actions done by setTeam(String, String).

Parameters:

teamIdentifier - Value to identify team. Must be a valid character for filesystem

Throws:

java.io.IOException - if files (Team.txt and TeamShort.txt) couldn't be written to

removeMap

public static void removeMap()
                      throws java.io.IOException

Remove the map image and name. Intended to cancel out all actions taken by setMap(String).

Throws:

java.io.IOException - if Map.txt couldn't be written to