Package outputProviders.logInputter

Class IterationResultFormatter

java.lang.Object

outputProviders.logInputter.IterationResultFormatter

public class IterationResultFormatter
extends Object

This class is used to format individual iteration results and their attributes.

Constructor Summary

Constructors

Constructor	Description
IterationResultFormatter(IterationResult iterationResult)	Constructor for the IterationResultFormatter.

Method Summary

Modifier and Type	Method	Description
static String	extractFileTypeExtension (String fullFileType)	Returns a string with information about the file type back to the extension itself E.g. ".txt [Unformatted Text Document]" -> ".txt" E.g. ".txt [Unformatted Text Document as Text file]" -> ".txt" E.g.
String	getFormattedErrorCode()	Default values of getFormatted error code, using the iteration result the formatter has been initialized with.
String	getFormattedErrorCode (boolean asText, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the error code of the iteration result the formatter has been initialized with as a string.
static String	getFormattedErrorCode (int errorCode)	Formats the exit code according to a string, with the default values.
static String	getFormattedErrorCode (int errorCode, boolean asText, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Formats the int exit code according to a string.
static String	getFormattedErrorCode (List<IterationResult> filteredResults)	Default values of static getFormatted error code.
static String	getFormattedErrorCode (List<IterationResult> filteredResults, boolean asText, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the error code of the filtered results as a string.
String	getFormattedIterationNumber()	Default values of getFormatted iteration number.
String	getFormattedIterationNumber (boolean titlePrefix, boolean commaSuffix, boolean newLineSuffix)	Formats the iteration number of the iteration results the formatter has been initialized with according to a string.
static String	getFormattedIterationNumber (int givenIterationNumber)	Contains the default values of the format iteration number method.
static String	getFormattedIterationNumber (int givenIterationNumber, boolean titlePrefix, boolean commaSuffix, boolean newLineSuffix)	Formats the int iteration number according to a string.
String	getFormattedMapFileCustomAttribute()	Default values of getFormatted map file custom attribute.
String	getFormattedMapFileCustomAttribute (boolean replaceEmpty, boolean replaceUnspecified, boolean replaceSpecialChars, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the custom attribute of the map file of the iteration result the formatter has been initialized with.
static String	getFormattedMapFileCustomAttribute (String customAttribute)	Default values of getFormatted map file custom attribute.
static String	getFormattedMapFileCustomAttribute (String customAttribute, boolean replaceEmpty, boolean replaceUnspecified, boolean replaceSpecialChars, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the custom attribute of the map file.
String	getFormattedMapFileName()	Default values of getFormatted map file name.
String	getFormattedMapFileName (boolean appendExtension, boolean appendFuzzAttemptNrText, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the name of the map file of the iteration result the formatter has been initialized with.
static String	getFormattedMapFileName (String mapFileName)	Default values of the getFormattedMapFileName method.
static String	getFormattedMapFileName (String mapFileName, boolean appendExtension, boolean appendFuzzAttemptNrText, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the name of the map file.
String	getFormattedMapFilePath()	Default values of getFormatted map file path.
String	getFormattedMapFilePath (boolean backslash, boolean relative, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the actual file path of the map in the correct subdirectory (in the actual/exit... ), of the iteration result the formatter has been initialized with.
static String	getFormattedMapFilePath (String mapFilePath)	Default values of getFormatted map file path.
static String	getFormattedMapFilePath (String mapFilePath, boolean backslash, boolean relative, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the actual file path of the map in the correct subdirectory.
String	getFormattedMapFileText()	Default values of getFormatted map file text.
String	getFormattedMapFileText (boolean deCapitalized, boolean asFullText, boolean replaceUnknown, boolean titlePrefix, boolean commaSuffix, boolean newLineSuffix)	Returns the full map file text as one string.
String	getFormattedMapFileType()	Default values of getFormatted map file type.
String	getFormattedMapFileType (boolean deCapitalize, boolean textOnly, boolean asText, boolean asFullText, boolean pointPrefix, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Formats the map file type of the iteration result the formatter has been initialized with according to a string.
static String	getFormattedMapFileType (String mapFileType)	Default values of getFormatted map file type.
static String	getFormattedMapFileType (String mapFileType, boolean deCapitalize, boolean textOnly, boolean asText, boolean asFullText, boolean pointPrefix, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Formats the map file type according to a string.
String	getFormattedOutputMessages()	Default values of getFormatted output messages.
String	getFormattedOutputMessages (boolean replaceUnspecified, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the output messages of the iteration result that the formatter has been initialized with as a string.
static String	getFormattedOutputMessages (String outputMessages)	Default values of the getFormattedOutputMessages method.
static String	getFormattedOutputMessages (String outputMessages, boolean replaceUnspecified, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the given output messages as a string.
static String	getFormattedOutputMessages (List<IterationResult> filteredResults)	Default values of static getFormatted output messages.
static String	getFormattedOutputMessages (List<IterationResult> filteredResults, boolean replaceUnspecified, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the output message as a string.
String	getFormattedStringSequence()	Default values of getFormatted string sequence.
String	getFormattedStringSequence (boolean deCapitalized, boolean fullText, boolean replaceUnknown, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the string sequence of the iteration result the formatter has been initialized with as one string.
static String	getFormattedStringSequence (String stringSequence)	Default values of getFormatted string sequence.
static String	getFormattedStringSequence (String stringSequence, boolean deCapitalized, boolean fullText, boolean replaceUnknown, boolean titlePrefix, boolean CSVReplacement, boolean commaSuffix, boolean newLineSuffix)	Returns the string sequence as one string.

Methods inherited from class java.lang.Object

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

Constructor Details

IterationResultFormatter

public IterationResultFormatter(IterationResult iterationResult)

Constructor for the IterationResultFormatter.

Parameters:

iterationResult - The result that needs formatting.

Method Details

getFormattedIterationNumber

public static String getFormattedIterationNumber
                
                (int givenIterationNumber,
 boolean titlePrefix,
 boolean commaSuffix,
 boolean newLineSuffix)

Formats the int iteration number according to a string.

Parameters:

givenIterationNumber - The iteration number to be formatted.

titlePrefix - True if the iteration number should have the title and colon appended. (E.g., Iteration Number: )

commaSuffix - True if the iteration number should have comma at the end.

newLineSuffix - True if the iteration number should have a newline at the end.

Returns:

The formatted iteration number as String.

getFormattedIterationNumber

public static String getFormattedIterationNumber
                
                (int givenIterationNumber)

Contains the default values of the format iteration number method.

Parameters:

givenIterationNumber - The iteration number to be formatted.

Returns:

The formatted iteration number as a String, with no title, and a comma appended at the end.

getFormattedIterationNumber

public String getFormattedIterationNumber(boolean titlePrefix,
 boolean commaSuffix,
 boolean newLineSuffix)

Formats the iteration number of the iteration results the formatter has been initialized with according to a string.

Parameters:

titlePrefix - True if the iteration number should have the title and colon appended. (E.g., Iteration Number: )

commaSuffix - True if the iteration number should have comma at the end.

newLineSuffix - True if the iteration number should have a newline at the end.

Returns:

The formatted iteration number.

getFormattedIterationNumber

public String getFormattedIterationNumber()

Default values of getFormatted iteration number. Formats the iteration number of the iteration result the formatter has been initialized with.

Returns:

Iteration number with comma appended and without title.

getFormattedErrorCode

public static String getFormattedErrorCode
            
            (int errorCode,
 boolean asText,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Formats the int exit code according to a string.

Parameters:

errorCode - The exit code to be formatted. Can be 0, 1, 10, -1.

asText - True if the exit code should be returned as text. (E.g., 0 becomes 1 (Crash). And -1 becomes Unknown)

titlePrefix - True if the variable name and a : should be appended in front. (E.g., Exit Code: )

CSVReplacement - True if the comma's and line breaks in the exit code should be replaced by an empty string.

commaSuffix - True if the exit code should have comma at the end.

newLineSuffix - True if the exit code should have a newline at the end.

Returns:

The formatted exit code as String.

getFormattedErrorCode

public static String getFormattedErrorCode
                
                (int errorCode)

Formats the exit code according to a string, with the default values.

Parameters:

errorCode - The exit code to be formatted. Can be 0, 1, 10, -1.

Returns:

The formatted exit code as String, with no title or additional text, with comma's and line breaks replaced, and a comma appended at the end.

getFormattedErrorCode

public String getFormattedErrorCode(boolean asText,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the error code of the iteration result the formatter has been initialized with as a string.

Parameters:

asText - - True if the error code should be returned as text. (E.g., 0 becomes 1 (Crash). And -1 becomes Unknown.)

titlePrefix - - True if the variable name and a : should be appended in front. (E.g., Exit Code: )

CSVReplacement - - True if the comma's and line breaks in the error code should be replaced by an empty string.

commaSuffix - - True if the error code should have comma at the end.

newLineSuffix - - True if the error code should have a newline at the end.

Returns:

String The formatted error code.

getFormattedErrorCode

public String getFormattedErrorCode()

Default values of getFormatted error code, using the iteration result the formatter has been initialized with.

Returns:

The formatted exit code as String, with no title or additional text, with comma's and line breaks replaced, and a comma appended at the end.

getFormattedErrorCode

public static String getFormattedErrorCode(List<IterationResult> filteredResults,
 boolean asText,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the error code of the filtered results as a string. Can only be used for filtered results that have one error code in common.

Parameters:

filteredResults - - The filtered results that have one error code in common.

asText - - True if the error code should be returned as text. (E.g., 0 becomes 0 (Crash). And -1 becomes Unknown.)

titlePrefix - - True if the variable name and a : should be appended in front. (E.g., Exit Code: )

CSVReplacement - - True if comma's and line breaks in should be replaced by an empty string.

commaSuffix - - True if the error code should have comma at the end.

newLineSuffix - - True if the error code should have a newline at the end.

Returns:

String The formatted error code.

getFormattedErrorCode

public static String getFormattedErrorCode(List<IterationResult> filteredResults)

Default values of static getFormatted error code.

Parameters:

filteredResults - The filtered results that have one error code in common.

Returns:

The formatted exit code as String, with no title or additional text, with comma's and line breaks replaced, and a comma appended at the end.

getFormattedOutputMessages

public static String getFormattedOutputMessages
                
                (String outputMessages,
 boolean replaceUnspecified,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the given output messages as a string.

Parameters:

outputMessages - The output messages that should be formatted. Can be "None" if the outputMessage is empty, or contain any text.

replaceUnspecified - - True if empty output messages should be replaced by "None" instead of a space.

titlePrefix - - True if the variable name and a : should be appended in front. (E.g., Output messages: )

CSVReplacement - - True if the comma's and line breaks in the output messages should be replaced by an empty string.

commaSuffix - - True if the output messages should have comma at the end.

newLineSuffix - - True if the output messages should have a newline at the end.

Returns:

String The formatted output messages.

getFormattedOutputMessages

public static String getFormattedOutputMessages
                
                (String outputMessages)

Default values of the getFormattedOutputMessages method.

Parameters:

outputMessages - The output message that needs formatting. Can be "None" if the outputMessage is empty, or contain any text.

Returns:

Output messages with comma and newline removed, with comma appended and "None" for empty ones.

getFormattedOutputMessages

public String getFormattedOutputMessages(boolean replaceUnspecified,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the output messages of the iteration result that the formatter has been initialized with as a string.

Parameters:

replaceUnspecified - - True if empty output messages should be replaced by "None" instead of a space.

titlePrefix - - True if the variable name and a : should be appended in front. (E.g., Output messages: )

CSVReplacement - - True if the comma's and line breaks in the output messages should be replaced by an empty string.

commaSuffix - - True if the output messages should have comma at the end.

newLineSuffix - - True if the output messages should have a newline at the end.

Returns:

String The formatted output messages.

getFormattedOutputMessages

public String getFormattedOutputMessages()

Default values of getFormatted output messages.

Returns:

Output messages of the iteration result the formatter has been initialized with, with comma and newline removed, with comma appended and "None" for empty ones.

getFormattedOutputMessages

public static String getFormattedOutputMessages(List<IterationResult> filteredResults,
 boolean replaceUnspecified,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the output message as a string. Can only be used for a list of filtered iterations results all have one output message in common.

Parameters:

filteredResults - The list of iterations that have the same output message.

replaceUnspecified - True if empty output messages should be replaced by a "None" instead of a space.

titlePrefix - True if the variable name and a : should be appended in front. (E.g., Output messages: )

CSVReplacement - True if the comma's and line breaks in output messages should be replaced by an empty string.

commaSuffix - True if the output messages should have comma at the end.

newLineSuffix - True if the output messages should have a newline at the end.

Returns:

String The formatted output messages.

getFormattedOutputMessages

public static String getFormattedOutputMessages(List<IterationResult> filteredResults)

Default values of static getFormatted output messages.

Parameters:

filteredResults - The list of iterations that have the same output message.

Returns:

Output messages with comma and newline removed, with comma appended and "None" for empty ones.

getFormattedStringSequence

public static String getFormattedStringSequence
            
            (String stringSequence,
 boolean deCapitalized,
 boolean fullText,
 boolean replaceUnknown,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the string sequence as one string.

Parameters:

stringSequence - - The string sequence that needs formatting.

deCapitalized - - True if all characters in the string sequence should be small.

fullText - - True if all characters in the string sequence should be replaced by their full meaning (e.g., E becomes Exit).

replaceUnknown - - True if unknown characters should be replaced by ?

titlePrefix - - True if the variable name and a : should be appended in front. (E.g., Action Sequence: )

CSVReplacement - - True if the comma's and line breaks in the string sequence should be replaced wih an empty string.

commaSuffix - - True if the string sequence type should have comma at the end.

newLineSuffix - - True if the string sequence type should have a newline at the end.

Returns:

String The formatted string sequence.

getFormattedStringSequence

public static String getFormattedStringSequence
                
                (String stringSequence)

Default values of getFormatted string sequence.

Parameters:

stringSequence - - The string sequence that needs formatting.

Returns:

String The formatted string sequence.

getFormattedStringSequence

public String getFormattedStringSequence(boolean deCapitalized,
 boolean fullText,
 boolean replaceUnknown,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the string sequence of the iteration result the formatter has been initialized with as one string.

Parameters:

deCapitalized - - True if all characters in the string sequence should be small.

fullText - - True if all characters in the string sequence should be replaced by their full meaning (e.g., E becomes Exit).

replaceUnknown - - True if unknown characters should be replaced by ?

titlePrefix - - True if the variable name and a : should be appended in front. (E.g., Action Sequence: )

CSVReplacement - - True if the comma's and line breaks in the string sequence should be replaced wih an empty string.

commaSuffix - - True if the string sequence type should have comma at the end.

newLineSuffix - - True if the string sequence type should have a newline at the end.

Returns:

String The formatted string sequence.

getFormattedStringSequence

public String getFormattedStringSequence()

Default values of getFormatted string sequence.

Returns:

String sequence of the iteration result the formatter has been initialized with, with comma and newline removed, with comma appended.

getFormattedMapFileName

public static String getFormattedMapFileName
                
                (String mapFileName,
 boolean appendExtension,
 boolean appendFuzzAttemptNrText,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the name of the map file.

Parameters:

mapFileName - The name that needs formatting, including its extension.

appendExtension - True if the file extension should be appended.

appendFuzzAttemptNrText - True if the fuzz attempt number should be appended (e.g. Fuzz attempt nr. 1: map_1.txt)

titlePrefix - True if the variable name and a : should be appended in front. (e.g., Map File Name: )

CSVReplacement - True if the map file type should have comma and newline removed.

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

String The formatted map file name.

getFormattedMapFileName

public static String getFormattedMapFileName
                
                (String mapFileName)

Default values of the getFormattedMapFileName method.

Parameters:

mapFileName - The name that needs formatting

Returns:

Map file name with comma and newline removed, with comma appended, and with extension.

getFormattedMapFileName

public String getFormattedMapFileName(boolean appendExtension,
 boolean appendFuzzAttemptNrText,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the name of the map file of the iteration result the formatter has been initialized with.

Parameters:

appendExtension - True if the file extension should be appended.

appendFuzzAttemptNrText - True if the fuzz attempt number should be appended (e.g. Fuzz attempt nr. 1: map_1.txt)

titlePrefix - True if the variable name and a : should be appended in front. (e.g., Map File Name: )

CSVReplacement - True if the map file type should have comma and newline removed.

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

String The formatted map file name.

getFormattedMapFileName

public String getFormattedMapFileName()

Default values of getFormatted map file name.

Returns:

Map file name of the iteration result the formatter has been initialized with, with comma and newline removed, with comma appended, and with extension.

getFormattedMapFileType

public static String getFormattedMapFileType
                
                (String mapFileType,
 boolean deCapitalize,
 boolean textOnly,
 boolean asText,
 boolean asFullText,
 boolean pointPrefix,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Formats the map file type according to a string.

Parameters:

mapFileType - The map file type that needs formatting, which is formatted as the extension with a point (e.g., .txt).

textOnly - True if the map file type should only be written out as text. (e.g., Unformatted Text Document)

CSVReplacement - True if the map file type should have comma and newline removed.

pointPrefix - True if the extension should start with .

deCapitalize - True if the extension should not be capitalized.

titlePrefix - True if the variable name and a : should be appended in front. (e.g., Map File Type: )

asText - True if the extension should additionally be written full-out (e.g. .exe [Executable file])

asFullText - True if the extension should additionally be written full-out and with extra information (e.g. .txt [Unformatted Text Document (Text document) as Text Document])

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

The formatted map file type.

getFormattedMapFileType

public static String getFormattedMapFileType
                
                (String mapFileType)

Default values of getFormatted map file type.

Parameters:

mapFileType - The map file type that needs formatting, which is formatted as the extension with a point (e.g., .txt).

Returns:

Decapitalized map file type with comma, full name and point appended, with comma and newline removed.

getFormattedMapFileType

public String getFormattedMapFileType(boolean deCapitalize,
 boolean textOnly,
 boolean asText,
 boolean asFullText,
 boolean pointPrefix,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Formats the map file type of the iteration result the formatter has been initialized with according to a string.

Parameters:

textOnly - True if the map file type should only be written out as text. (e.g., Unformatted Text Document)

CSVReplacement - True if the map file type should have comma and newline removed.

pointPrefix - True if the extension should start with .

deCapitalize - True if the extension should not be capitalized.

titlePrefix - True if the variable name and a : should be appended in front. (e.g., Map File Type: )

asText - True if the extension should additionally be written full-out (e.g. .exe [Executable file])

asFullText - True if the extension should additionally be written full-out and with extra information (e.g. .txt [Unformatted Text Document (Text document) as Text Document])

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

The formatted map file type.

getFormattedMapFileType

public String getFormattedMapFileType()

Default values of getFormatted map file type.

Returns:

Decapitalized map file type of the iteration result the formatter has been initialized with, with comma, full name and point appended, with comma and newline removed.

extractFileTypeExtension

public static String extractFileTypeExtension
                
                (String fullFileType)

Returns a string with information about the file type back to the extension itself E.g. ".txt [Unformatted Text Document]" -> ".txt" E.g. ".txt [Unformatted Text Document as Text file]" -> ".txt" E.g. "Unformatted Text Document" -> "Unformatted Text Document"

Parameters:

fullFileType - The full file type with the extension and the text

Returns:

The extension only

getFormattedMapFileCustomAttribute

public static String getFormattedMapFileCustomAttribute
                
                (String customAttribute,
 boolean replaceEmpty,
 boolean replaceUnspecified,
 boolean replaceSpecialChars,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the custom attribute of the map file.

Parameters:

customAttribute - The custom attribute of the map file. Can be "None" if empty, or contain any other text.

replaceEmpty - True if the spaces and tabs characters in the custom attribute should be replaced by "Empty or blank string."

replaceUnspecified - True if map files without a custom attribute should be replaced by "None" instead of a space.

replaceSpecialChars - True if custom attributes that have special characters such as / and " should be replaced by "String contains special characters."

titlePrefix - True if the variable name and a : should be appended in front. (e.g. Map File Custom Attribute: )

CSVReplacement - True if the map file type should have comma and newline removed.

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

String The formatted map file custom attribute.

getFormattedMapFileCustomAttribute

public static String getFormattedMapFileCustomAttribute
                
                (String customAttribute)

Default values of getFormatted map file custom attribute.

Parameters:

customAttribute - The custom attribute of the map file. Can be "None" if empty, or contain any other text.

Returns:

String Map file custom attribute with comma and newline removed, with comma appended, and with extension. The empty and special characters are replaced, as well as unspecified map file custom attributes.

getFormattedMapFileCustomAttribute

public String getFormattedMapFileCustomAttribute(boolean replaceEmpty,
 boolean replaceUnspecified,
 boolean replaceSpecialChars,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the custom attribute of the map file of the iteration result the formatter has been initialized with.

Parameters:

replaceEmpty - True if the spaces and tabs characters in the custom attribute should be replaced by "Empty or blank string."

replaceUnspecified - True if map files without a custom attribute should be replaced by "None" instead of a space.

replaceSpecialChars - True if custom attributes that have special characters such as / and " should be replaced by "String contains special characters."

titlePrefix - True if the variable name and a : should be appended in front. (e.g. Map File Custom Attribute: )

CSVReplacement - True if the map file type should have comma and newline removed.

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

String The formatted map file custom attribute.

getFormattedMapFileCustomAttribute

public String getFormattedMapFileCustomAttribute()

Default values of getFormatted map file custom attribute.

Returns:

Map file custom attribute of the iteration result the formatter has been initialized with, with comma and newline removed, with comma appended, and with extension. The empty and special characters are replaced, as well as unspecified map file custom attributes.

getFormattedMapFilePath

public static String getFormattedMapFilePath
                
                (String mapFilePath,
 boolean backslash,
 boolean relative,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the actual file path of the map in the correct subdirectory.

Parameters:

mapFilePath - The actual file path of the map in the correct subdirectory. This will not change the file path (only normalize it)

backslash - boolean if backslash should be used instead of forward slash.

relative - boolean if the relative path should be used instead of the absolute path.

titlePrefix - True if the variable name and a : should be appended in front (e.g., Absolute (or Relative) Map File Path: ).

CSVReplacement - True if the map file type should have comma and newline removed.

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

String The formatted map file path.

getFormattedMapFilePath

public static String getFormattedMapFilePath
                
                (String mapFilePath)

Default values of getFormatted map file path.

Parameters:

mapFilePath - The actual file path of the map in the correct subdirectory. This will not change the path.

Returns:

String the formatted map file path.

getFormattedMapFilePath

public String getFormattedMapFilePath(boolean backslash,
 boolean relative,
 boolean titlePrefix,
 boolean CSVReplacement,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the actual file path of the map in the correct subdirectory (in the actual/exit... ), of the iteration result the formatter has been initialized with.

Parameters:

backslash - boolean if backslash should be used instead of forward slash.

relative - boolean if the relative path should be used instead of the absolute path.

titlePrefix - True if the variable name and a : should be appended in front (e.g., Absolute (or Relative) Map File Path: ).

CSVReplacement - True if the map file type should have comma and newline removed.

commaSuffix - True if the map file type should have comma at the end.

newLineSuffix - True if the map file type should have a newline at the end.

Returns:

String The formatted map file path in the correct actual subdirectory.

getFormattedMapFilePath

public String getFormattedMapFilePath()

Default values of getFormatted map file path.

Returns:

Absolute map file path of the iteration result the formatter has been intitialized with, with comma appended afterwards, with /, with comma and newline removed.

getFormattedMapFileText

public String getFormattedMapFileText(boolean deCapitalized,
 boolean asFullText,
 boolean replaceUnknown,
 boolean titlePrefix,
 boolean commaSuffix,
 boolean newLineSuffix)

Returns the full map file text as one string. Not possible in CSV File, since map files can be multi line.

Parameters:

deCapitalized - - True if all characters in the map file should be small.

asFullText - - True if all characters in the map file should be replaced by their full meaning (e.g., P becomes Player).

replaceUnknown - - True if unknown characters should be replaced by ?

titlePrefix - - True if the variable name and a : should be appended in front (e.g.,: Map File Text: )

commaSuffix - - True if the map file type should have comma at the end.

newLineSuffix - - True if the map file type should have a newline at the end.

Returns:

String The formatted map file text.

getFormattedMapFileText

public String getFormattedMapFileText()

Default values of getFormatted map file text.

Returns:

Map file text with comma and newline removed, with comma appended.