Index

A B C D E F G I L M P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values

A

ANSI - Class in com.github.rhys_h_walker.misc

Static references to ANSI colour codes

B

BLACK - Static variable in class com.github.rhys_h_walker.misc.ANSI

Black text code

BLACK_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

Black background text code

BLUE - Static variable in class com.github.rhys_h_walker.misc.ANSI

Blue text code

BLUE_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

Blue background text code

C

changeLogVisibility(LoggingType, boolean) - Static method in class com.github.rhys_h_walker.Logger

Change whether a log type is visibile or not

changeLogVisibilityMap(HashMap<LoggingType, Boolean>) - Static method in class com.github.rhys_h_walker.Logger

Set the log visibility map This map must have all 6 logging types included with none set to null value

cleanFileNameString(String) - Static method in class com.github.rhys_h_walker.misc.Utilities

Clean a non empty String for use as a filename REGEX USED = INVALID_FILENAME_CHARS_REGEX *Check Utilities.java* Trailing dots and spaces removed File name size limit imposed 100 chars On error no alternative name will be given

cleanup() - Method in class com.github.rhys_h_walker.factories.LogFactory

Close any system resources correctly

com.github.rhys_h_walker - package com.github.rhys_h_walker

com.github.rhys_h_walker.core_enums - package com.github.rhys_h_walker.core_enums

com.github.rhys_h_walker.core_objects - package com.github.rhys_h_walker.core_objects

com.github.rhys_h_walker.factories - package com.github.rhys_h_walker.factories

com.github.rhys_h_walker.misc - package com.github.rhys_h_walker.misc

createNewLog(String, LoggingType) - Method in class com.github.rhys_h_walker.factories.LogFactory

Create a new log given a log type and message

CYAN - Static variable in class com.github.rhys_h_walker.misc.ANSI

Cyan text code

CYAN_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

Cyan background text code

D

DEBUG - Enum constant in enum class com.github.rhys_h_walker.core_enums.LoggingType

Logging of any debuging information

defaultVisibility() - Static method in enum class com.github.rhys_h_walker.core_enums.LoggingType

The default hashmap that is created will only feature ERROR: True

E

ERROR - Enum constant in enum class com.github.rhys_h_walker.core_enums.LoggingType

Logging of any error messages

F

FileManagement - Class in com.github.rhys_h_walker

A static class which implements most of the IO features required by OnRailsLogger

formatFilepathFromTimestamp(LocalDateTime, File) - Static method in class com.github.rhys_h_walker.misc.Utilities

Create a path from a timestamp and app directory

G

getApplicationName() - Static method in class com.github.rhys_h_walker.Logger

Get the name of the currently running application

getId() - Method in class com.github.rhys_h_walker.core_objects.Log

Get the ID String for this log

getLoggingType() - Method in class com.github.rhys_h_walker.core_objects.Log

Get the logging type this log is a member of

getLogMessage() - Method in class com.github.rhys_h_walker.core_objects.Log

Get the logging message that is associated with this log

getTimestamp() - Method in class com.github.rhys_h_walker.core_objects.Log

Get the timestamp associated with this log

GREEN - Static variable in class com.github.rhys_h_walker.misc.ANSI

Green text code

GREEN_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

Green background text code

I

INFO - Enum constant in enum class com.github.rhys_h_walker.core_enums.LoggingType

Logging of any general information about the system

initialized() - Method in class com.github.rhys_h_walker.factories.LogFactory

Has this LogFactory been initialized

initializeLogger(String, boolean) - Static method in class com.github.rhys_h_walker.Logger

Initialize with an application name and default logging visibility

initializeLogger(String, HashMap<LoggingType, Boolean>, boolean) - Static method in class com.github.rhys_h_walker.Logger

Initialize the logging logic

L

locateFile(LocalDateTime, File) - Static method in class com.github.rhys_h_walker.FileManagement

Based on a timestamp either locate or create a file for logging

Log - Class in com.github.rhys_h_walker.core_objects

Representation of a Log in memory, not used for creating and outputing Will be used for viewing logs that exist in memory BIG NOTE: Currently not used by the program, this is retained for future use

Log(LoggingType, String, String, String) - Constructor for class com.github.rhys_h_walker.core_objects.Log

Create a new log object on the fly and outputs correctly to the console

logdebug(String) - Static method in class com.github.rhys_h_walker.Logger

Log a debug message

logerror(String) - Static method in class com.github.rhys_h_walker.Logger

Log an error message

LogFactory - Class in com.github.rhys_h_walker.factories

Class that creates and stores logs in the correct location based on information supplied upon construction of the logger.

LogFactory(String) - Constructor for class com.github.rhys_h_walker.factories.LogFactory

Create a LogFactory for a specific application All logs will be located under this name like this: user.home/OnRailsLogging/applicationName/ regular dated directory structure THIS METHOD WILL RETURN ON ANY ERROR

Logger - Class in com.github.rhys_h_walker

The primary entrypoint for a the logger.

LoggingType - Enum Class in com.github.rhys_h_walker.core_enums

Type labels for different log messages Definitions located on the GitHub here: https://github.com/rhys-h-walker/OnRailsLogging/blob/main/README.md

loginfo(String) - Static method in class com.github.rhys_h_walker.Logger

Log a info message

logmiscellaneous(String) - Static method in class com.github.rhys_h_walker.Logger

Log a miscellaneous message

logprogress(String) - Static method in class com.github.rhys_h_walker.Logger

Log a progress message

logVisibilityAllFalse() - Static method in enum class com.github.rhys_h_walker.core_enums.LoggingType

Create a hashmap with all logging types set to false

logVisibilityAllTrue() - Static method in enum class com.github.rhys_h_walker.core_enums.LoggingType

Create a hashmap with all logging types set to true

logwarn(String) - Static method in class com.github.rhys_h_walker.Logger

Log a warning message

M

MAGENTA - Static variable in class com.github.rhys_h_walker.misc.ANSI

Magenta text code

MAGENTA_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

Magenta background text code

MISCELLANEOUS - Enum constant in enum class com.github.rhys_h_walker.core_enums.LoggingType

Logging of miscelaneous messages that do not fit into any other category

P

PROGRESS - Enum constant in enum class com.github.rhys_h_walker.core_enums.LoggingType

Logging of any messages that signify progress of the system

R

readLogFile(File) - Static method in class com.github.rhys_h_walker.FileManagement

Read in a log file and return it split by line

RED - Static variable in class com.github.rhys_h_walker.misc.ANSI

Red text code

RED_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

Red background text code

removeLeadingZeros(String) - Static method in class com.github.rhys_h_walker.misc.Utilities

Remove all leading zeros from a String

RESET - Static variable in class com.github.rhys_h_walker.misc.ANSI

Reset ANSI code

S

shutdown() - Static method in class com.github.rhys_h_walker.Logger

Shutdown command for the logger, releases all system resources.

T

TimestampDecoder - Class in com.github.rhys_h_walker.misc

Static method to decode a String timestamp into various useful formats

timestampToFile(String) - Static method in class com.github.rhys_h_walker.misc.TimestampDecoder

Resolve a timestamp into a File object for Java This method assumes the timestamp given complies with the format "year-month-day-hour:minute:second" No checking is done as to whether this is true No checking is done whether it even exists

U

Utilities - Class in com.github.rhys_h_walker.misc

A class of general purpose utilities

V

valueOf(String) - Static method in enum class com.github.rhys_h_walker.core_enums.LoggingType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.github.rhys_h_walker.core_enums.LoggingType

Returns an array containing the constants of this enum class, in the order they are declared.

viewLogVisibility(LoggingType) - Static method in class com.github.rhys_h_walker.Logger

Is a log type currently visible

viewVisibilityMap() - Static method in class com.github.rhys_h_walker.Logger

Get the log visibility map

W

WARN - Enum constant in enum class com.github.rhys_h_walker.core_enums.LoggingType

Logging of any warnings that the program may create

WHITE - Static variable in class com.github.rhys_h_walker.misc.ANSI

White text code

WHITE_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

White background text code

writeToLogFile(String, LoggingType, String, PrintWriter) - Static method in class com.github.rhys_h_walker.FileManagement

Write a log message to a given file.

Y

YELLOW - Static variable in class com.github.rhys_h_walker.misc.ANSI

Yellow text code

YELLOW_BG - Static variable in class com.github.rhys_h_walker.misc.ANSI

Yellow background text code

A B C D E F G I L M P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values