Index

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

A

acceptLogRootRefs(UUID, String, Map<Long, String>) - Method in interface com.clumd.projects.java_common_utils.logging.api.CustomLogHandler

A method to act as an initialiser for any Custom Log Controller

acceptLogRootRefs(UUID, String, Map<Long, String>) - Method in class com.clumd.projects.java_common_utils.logging.controllers.ConsoleController

acceptLogRootRefs(UUID, String, Map<Long, String>) - Method in class com.clumd.projects.java_common_utils.logging.controllers.FileController

ALL - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

ANON_THREAD - Static variable in class com.clumd.projects.java_common_utils.logging.LogRoot

Argument<T> - Class in com.clumd.projects.java_common_utils.arg_parser

This Class represents all the configuration required to parse a single Command Line Argument into a usable output

Argument.ArgumentBuilder<T> - Class in com.clumd.projects.java_common_utils.arg_parser

argumentResult(T) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

If this argument needs a value, then this should be the fully validated and parsed output of that value.

attemptValueConversion(String) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

This method should be called by the implementing CLIArgParser if a value is provided for this Argument.

B

basicConsoleHandler(boolean) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Create a basic instance of a Console Handler with various defaults set.

basicFileHandler() - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

As LogRoot.basicFileHandler(String) but the directory is defaulted to the CURRENT WORKING DIRECTORY WHEN THE JAVA PROCESS WAS STARTED.

basicFileHandler(String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Create a basic instance of a File Handler with various defaults set.

BLACK - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BLACK_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BLUE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BLUE_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BOLD - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_BLACK - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_BLACK_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_BLUE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_BLUE_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_CYAN - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_CYAN_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_GREEN - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_GREEN_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_PURPLE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_PURPLE_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_RED - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_RED_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_WHITE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_WHITE_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_YELLOW - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

BRIGHT_YELLOW_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

build() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

builder() - Static method in class com.clumd.projects.java_common_utils.arg_parser.Argument

C

canEqual(Object) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

canEqual(Object) - Method in class com.clumd.projects.java_common_utils.models.Pair

CLIArgParser - Interface in com.clumd.projects.java_common_utils.arg_parser

This represents the implementation of a class capable of parsing Arguments from the command line.

COLOUR_RESET - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

com.clumd.projects.java_common_utils - package com.clumd.projects.java_common_utils

com.clumd.projects.java_common_utils.arg_parser - package com.clumd.projects.java_common_utils.arg_parser

com.clumd.projects.java_common_utils.files - package com.clumd.projects.java_common_utils.files

com.clumd.projects.java_common_utils.logging - package com.clumd.projects.java_common_utils.logging

com.clumd.projects.java_common_utils.logging.api - package com.clumd.projects.java_common_utils.logging.api

com.clumd.projects.java_common_utils.logging.common - package com.clumd.projects.java_common_utils.logging.common

com.clumd.projects.java_common_utils.logging.controllers - package com.clumd.projects.java_common_utils.logging.controllers

com.clumd.projects.java_common_utils.models - package com.clumd.projects.java_common_utils.models

CONFIG - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

CONSOLE_DATE_TIME_FORMATTER - Static variable in class com.clumd.projects.java_common_utils.logging.controllers.ConsoleController

ConsoleController - Class in com.clumd.projects.java_common_utils.logging.controllers

ConsoleController(boolean) - Constructor for class com.clumd.projects.java_common_utils.logging.controllers.ConsoleController

conversionFunction(Function<String, T>) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

This function is used to convert an argument from the CLI string form, into the object the running process needs.

createFormat(Collection<Format>) - Static method in enum class com.clumd.projects.java_common_utils.logging.common.Format

Used to create a custom Log Format with a selection of format modifiers, this can include Bold, underline and colour for example.

createLogger(Class<?>) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to create a Logger instance by referencing the Class you want the logger for.

createLogger(String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to create a Logger instance by a string name.

createLogger(String, String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to create a Logger instance by a string name, with a custom prefix.

CRITICAL - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

CustomLevel - Class in com.clumd.projects.java_common_utils.logging.common

CustomLevel(String, int) - Constructor for class com.clumd.projects.java_common_utils.logging.common.CustomLevel

CustomLevel(String, int, LogLevelFormat) - Constructor for class com.clumd.projects.java_common_utils.logging.common.CustomLevel

CustomLevel(String, int, String) - Constructor for class com.clumd.projects.java_common_utils.logging.common.CustomLevel

CustomLogHandler - Interface in com.clumd.projects.java_common_utils.logging.api

An Interface to ensure that a custom Log Controller instance is capable of accepting some variables which should included in logs.

CYAN - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

CYAN_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

D

DATA - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

DEBUG - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

defaultValue(T) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to set the default value, and also mark that the default value has been set.

defaultValueSet(boolean) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to track if a default value has been set for this argument to be used if no CLI value is found.

deleteDirectoryIfExists(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Used to delete a directory on the filesystem if it exists, if not - no action is taken.

deleteFileIfExists(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Used to delete a file on the filesystem if it exists, if not - no action is taken.

deleteIfExists(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Used to delete an item on the filesystem if it exists, if not - no action is taken.

description(String) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to describe the purpose of this Argument and how it should be used.

E

EMERGENCY - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

equals(Object) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

equals(Object) - Method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

equals(Object) - Method in class com.clumd.projects.java_common_utils.models.Pair

ERROR - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

ExtendedLogger - Class in com.clumd.projects.java_common_utils.logging

This class is a very basic extension of the built-in JUL Logger, but with an expansive selection of 'log' methods for all the combinations of operations the average user might require.

ExtendedLogger(String) - Constructor for class com.clumd.projects.java_common_utils.logging.ExtendedLogger

Protected method to construct a logger for a named subsystem.

ExtendedLogRecord - Class in com.clumd.projects.java_common_utils.logging.common

An extended LogRecord which also supports the notion of 'tagging' log messages.

ExtendedLogRecord(Level, String) - Constructor for class com.clumd.projects.java_common_utils.logging.common.ExtendedLogRecord

ExtendedLogRecord(Level, String, String) - Constructor for class com.clumd.projects.java_common_utils.logging.common.ExtendedLogRecord

ExtendedLogRecord(Level, String, Set<String>) - Constructor for class com.clumd.projects.java_common_utils.logging.common.ExtendedLogRecord

F

FAILURE - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

FATAL - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

FILE_DATE_TIME_FORMATTER - Static variable in class com.clumd.projects.java_common_utils.logging.controllers.FileController

FileController - Class in com.clumd.projects.java_common_utils.logging.controllers

FileController(String, int, int, boolean) - Constructor for class com.clumd.projects.java_common_utils.logging.controllers.FileController

Pass-through constructor ensuring we will use the desired custom formatter, and match ALL records.

FileUtils - Class in com.clumd.projects.java_common_utils.files

A collection of useful methods to call for various File operations I find myself needing to do frequently.

Format - Enum Class in com.clumd.projects.java_common_utils.logging.common

Simple Formatting Utility class to describe basic transformations you could do to a Console Log String.

G

getArgumentResult() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

If this argument needs a value, then this should be the fully validated and parsed output of that value.

getBoilerplate(Collection<Argument<?>>) - Method in interface com.clumd.projects.java_common_utils.arg_parser.CLIArgParser

Used to get the boilerplate message that can be used to print to the CLI with the relevant argument options and their usage descriptions.

getBoilerplate(Collection<Argument<?>>) - Method in class com.clumd.projects.java_common_utils.arg_parser.JavaArgParser

getConversionFunction() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

This function is used to convert an argument from the CLI string form, into the object the running process needs.

getDefaultValue() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

This should be used as the default value, if nothing is provided for the conversion function

getDescription() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to describe the purpose of this Argument and how it should be used.

getFileAsBytes(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

This is used to return the raw bytes of a given file.

getFileAsString(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

This method takes a file path, and concats all the content into a single string.

getFileAsStrings(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

This method takes a file path, and returns an array of strings for each line in the file.

getFirst() - Method in class com.clumd.projects.java_common_utils.models.Pair

getFormatString() - Method in interface com.clumd.projects.java_common_utils.logging.api.LogLevelFormat

Gets the formatting string for the associated Log level

getFormatString() - Method in enum class com.clumd.projects.java_common_utils.logging.common.Format

getFormattedLogData() - Method in interface com.clumd.projects.java_common_utils.logging.api.LoggableData

Used to return the data the implementing class would like to display within a Log statement.

getLeft() - Method in class com.clumd.projects.java_common_utils.models.Pair

getLevelFormat() - Method in interface com.clumd.projects.java_common_utils.logging.api.LogLevel

Get the formatting this Log Level should be displayed with

getLevelFormat() - Method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

getLevelName() - Method in interface com.clumd.projects.java_common_utils.logging.api.LogLevel

Get the name of this Log Level.

getLevelName() - Method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

getLocalResourceAsString(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

This is used to get a file part of the source as a string.

getLocalResourceAsStrings(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

This is used to get the contents of a file line by line.

getLongOptions() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to contain all the word alias' to indicate this option

getPriority() - Method in interface com.clumd.projects.java_common_utils.logging.api.LogLevel

Get the priority of this Log Level

getPriority() - Method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

getRight() - Method in class com.clumd.projects.java_common_utils.models.Pair

getSecond() - Method in class com.clumd.projects.java_common_utils.models.Pair

getShortOptions() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to contain all the single character alias' to indicate this option

getTags() - Method in class com.clumd.projects.java_common_utils.logging.common.ExtendedLogRecord

getUniqueId() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to index the options, must be unique and supplied by the user.

getValidationFunction() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

This function can be provided to run a verification step that the argument's value is acceptable.

GREEN - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

GREEN_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

H

hashCode() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

hashCode() - Method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

hashCode() - Method in class com.clumd.projects.java_common_utils.models.Pair

hasValue() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to indicate if this argument can be followed by a value, defaults to false

hasValue(boolean) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to indicate if this argument can be followed by a value, defaults to false

I

ImmutablePair<L extends Serializable,R extends Serializable> - Class in com.clumd.projects.java_common_utils.models

An instance of Pair, but where the values are immutable, and references cannot be changed once set.

ImmutablePair(L, R) - Constructor for class com.clumd.projects.java_common_utils.models.ImmutablePair

IMPORTANT - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

INFO - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

init(String, String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

As LogRoot.init(String, String, String), but with systemID defaulting to null, which will use some programmatic ID, involving system hostname.

init(String, String, String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to initialise the Log Root with some base parameters.

isDefaultValueSet() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to track if a default value has been set for this argument to be used if no CLI value is found.

isMandatory() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to indicate if this argument is mandatory and MUST be provided for the utilising code to function.

isMandatory(boolean) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to indicate if this argument is mandatory and MUST be provided for the utilising code to function.

ITALIC - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

J

JavaArgParser - Class in com.clumd.projects.java_common_utils.arg_parser

A useful implementation of CLIArgParser with all basic features supported.

JavaArgParser() - Constructor for class com.clumd.projects.java_common_utils.arg_parser.JavaArgParser

L

log(Level, String) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, String) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, String, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, String, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, String, Throwable) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, String, Throwable, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, String, Throwable, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Throwable) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Throwable, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Throwable, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Supplier<String>) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Supplier<String>, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Supplier<String>, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Supplier<String>, Throwable) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Supplier<String>, Throwable, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, String, Supplier<String>, Throwable, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Supplier<String>) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Supplier<String>, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Supplier<String>, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Supplier<String>, Throwable) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Supplier<String>, Throwable, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Supplier<String>, Throwable, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, String) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, String, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, String, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, String, Throwable) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, String, Throwable, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, String, Throwable, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, Supplier<String>) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, Supplier<String>, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, Supplier<String>, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, Supplier<String>, Throwable) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, Supplier<String>, Throwable, Object) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

log(Level, Set<String>, Supplier<String>, Throwable, Object[]) - Method in class com.clumd.projects.java_common_utils.logging.ExtendedLogger

LoggableData - Interface in com.clumd.projects.java_common_utils.logging.api

This interface should be used to indicate that a class implements a method to format itself in a design suitable for logging.

LogLevel - Interface in com.clumd.projects.java_common_utils.logging.api

Define a custom extended LogLevel which should always extend Level, but provide some additional fields and functionality.

LogLevelFormat - Interface in com.clumd.projects.java_common_utils.logging.api

Used as a marker interface for the Formatting of an extended LogLevel

LogRoot - Class in com.clumd.projects.java_common_utils.logging

This class is a de-facto root for all Extended Logging functionality.

longOptions(Set<String>) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to contain all the word alias' to indicate this option

M

main(String[]) - Static method in class com.clumd.projects.java_common_utils.logging.Main

main(String[]) - Static method in class com.clumd.projects.java_common_utils.Main

Main - Class in com.clumd.projects.java_common_utils.logging

Main - Class in com.clumd.projects.java_common_utils

Main() - Constructor for class com.clumd.projects.java_common_utils.logging.Main

Main() - Constructor for class com.clumd.projects.java_common_utils.Main

makeAllDirs(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Create all the containing directories INCLUDING the leaf for the given path, if not exists.

makeContainingDirs(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Create all the containing directories for the given path, if not exists.

MINOR - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

N

NONE - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

NOTIFICATION - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

O

of(String, int) - Static method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

of(String, int, LogLevelFormat) - Static method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

of(String, int, String) - Static method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

of(L, R) - Static method in class com.clumd.projects.java_common_utils.models.ImmutablePair

of(L, R) - Static method in class com.clumd.projects.java_common_utils.models.Pair

OFF - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

OUTLINE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

P

Pair<L extends Serializable,R extends Serializable> - Class in com.clumd.projects.java_common_utils.models

A simple 'Pair' concept, which groups together two objects, via whatever logical grouping the user believes.

Pair(L, R) - Constructor for class com.clumd.projects.java_common_utils.models.Pair

parseFromCLI(Collection<Argument<?>>, String[]) - Method in interface com.clumd.projects.java_common_utils.arg_parser.CLIArgParser

As CLIArgParser.parseFromCLI(Collection, String[], boolean, boolean), but defaulting to false for ignoreUnknownCLIArgs and returnArgsWithDefaultButNotOnCLI

parseFromCLI(Collection<Argument<?>>, String[]) - Method in class com.clumd.projects.java_common_utils.arg_parser.JavaArgParser

parseFromCLI(Collection<Argument<?>>, String[], boolean, boolean) - Method in interface com.clumd.projects.java_common_utils.arg_parser.CLIArgParser

Used to execute the parsing process of Command line arguments into validated program input.

parseFromCLI(Collection<Argument<?>>, String[], boolean, boolean) - Method in class com.clumd.projects.java_common_utils.arg_parser.JavaArgParser

PURPLE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

PURPLE_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

R

RED - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

RED_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

RESET - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

S

setApplicationGlobalLevel(CustomLevel) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Set the log level across every Logger created within this API to the given Custom Level, but do NOT touch loggers used by 3rd party dependencies.

setArgumentResult(T) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

If this argument needs a value, then this should be the fully validated and parsed output of that value.

setBoilerplate(String, String, String, String, String) - Method in interface com.clumd.projects.java_common_utils.arg_parser.CLIArgParser

Used to set all the Strings which should be used if printing help text.

setBoilerplate(String, String, String, String, String) - Method in class com.clumd.projects.java_common_utils.arg_parser.JavaArgParser

setBranchLoggingLevel(CustomLevel, String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to set the logging level of the indicated branch of package hierarchy.

setBranchLoggingLevel(CustomLevel, Logger) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to set the logging level of the indicated branch of package hierarchy.

setBranchLoggingLevel(CustomLevel, String, String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to set the logging level of the indicated branch of package hierarchy.

setDefaultValue(T) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

This should be used as the default value, if nothing is provided for the conversion function

setDefaultValueSet(boolean) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to track if a default value has been set for this argument to be used if no CLI value is found.

setFirst(L) - Method in class com.clumd.projects.java_common_utils.models.ImmutablePair

setFirst(L) - Method in class com.clumd.projects.java_common_utils.models.Pair

setGlobalBranchLoggingLevel(CustomLevel, String) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to set the logging level of the indicated branch of package hierarchy.

setGlobalLoggingLevel(CustomLevel) - Static method in class com.clumd.projects.java_common_utils.logging.LogRoot

Set the log level across the entire JVM to the given Custom Level.

setLeft(L) - Method in class com.clumd.projects.java_common_utils.models.ImmutablePair

setLeft(L) - Method in class com.clumd.projects.java_common_utils.models.Pair

setRight(R) - Method in class com.clumd.projects.java_common_utils.models.ImmutablePair

setRight(R) - Method in class com.clumd.projects.java_common_utils.models.Pair

setSecond(R) - Method in class com.clumd.projects.java_common_utils.models.ImmutablePair

setSecond(R) - Method in class com.clumd.projects.java_common_utils.models.Pair

SEVERE - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

shortOptions(Set<Character>) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to contain all the single character alias' to indicate this option

SHUTDOWN - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

SUCCESS - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

T

TAB - Static variable in class com.clumd.projects.java_common_utils.logging.LogRoot

TESTING - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

toString() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

toString() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

toString() - Method in class com.clumd.projects.java_common_utils.models.Pair

TRACE - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

U

UNDERLINE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

uniqueId(int) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to index the options, must be unique and supplied by the user.

V

validateIsDirectory(String) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

This is used to validate the existence (as a directory) and permission to read from the given path.

validateValue() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

If a value is possible for this CLI Argument, then this method will be called to verify that the argument provided is acceptable by the calling process.

validationFunction(Function<T, Boolean>) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

This function can be provided to run a verification step that the argument's value is acceptable.

valueIsOptional() - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument

Used to indicate if the value to this argument can be optional, defaults to false.

valueIsOptional(boolean) - Method in class com.clumd.projects.java_common_utils.arg_parser.Argument.ArgumentBuilder

Used to indicate if the value to this argument can be optional, defaults to false.

valueOf(String) - Static method in enum class com.clumd.projects.java_common_utils.logging.common.Format

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

values() - Static method in enum class com.clumd.projects.java_common_utils.logging.common.Format

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

VERBOSE - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

W

WARNING - Static variable in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

weakEquals(Object) - Method in class com.clumd.projects.java_common_utils.logging.common.CustomLevel

WHITE - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

WHITE_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

withHandlers(Collection<CustomLogHandler>) - Method in class com.clumd.projects.java_common_utils.logging.LogRoot

Used to enhance the LogRoot with instances of Log Handler which will be used to capture all LogRecords written during the runtime of the application using this API.

writeBytesToFile(byte[], String, boolean) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Used to write raw bytes to a file.

writeStringsToFile(Collection<String>, String, boolean) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Used to write multiple strings to a file.

writeStringToFile(String, String, boolean) - Static method in class com.clumd.projects.java_common_utils.files.FileUtils

Used to write a single string to a file.

Y

YELLOW - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

YELLOW_BACKGROUND - Enum constant in enum class com.clumd.projects.java_common_utils.logging.common.Format

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