Index (org.refcodes:refcodes-runtime 3.1.1 API)

A C D E F G H I K M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values

A

ABSOLUTE - Enum constant in enum class org.refcodes.runtime.ConfigLocator: None as of the folders as of the ConfigLocator enumeration are considered.
addShutdownHook(Runnable) - Static method in class org.refcodes.runtime.RuntimeUtility: Registers a new virtual-machine shutdown hook.
addShutdownHook(Thread) - Static method in class org.refcodes.runtime.RuntimeUtility: Registers a new virtual-machine shutdown hook.
ALIAS_GET - Static variable in class org.refcodes.runtime.ReflectionUtility
ALIAS_HAS - Static variable in class org.refcodes.runtime.ReflectionUtility
ALIAS_IS - Static variable in class org.refcodes.runtime.ReflectionUtility
ALIAS_SET - Static variable in class org.refcodes.runtime.ReflectionUtility
ALIAS_TOSTRING - Static variable in class org.refcodes.runtime.ReflectionUtility
ALL - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of folders as of the ConfigLocator enumeration.
annotations(Class<?>) - Static method in class org.refcodes.runtime.AnnotationSugar: Gatherers all annotations annotating a provided Class.
annotations(Class<?>) - Static method in class org.refcodes.runtime.ReflectionUtility: Gatherers all annotations annotating a provided Class.
annotations(Object) - Static method in class org.refcodes.runtime.AnnotationSugar: Gatherers all annotations annotating a provided Object.
annotations(Object) - Static method in class org.refcodes.runtime.ReflectionUtility: Gatherers all annotations annotating a provided Object.
annotations(Field) - Static method in class org.refcodes.runtime.AnnotationSugar: Gatherers all annotations annotating a provided Field.
annotations(Field) - Static method in class org.refcodes.runtime.ReflectionUtility: Gatherers all annotations annotating a provided Field.
annotations(Method) - Static method in class org.refcodes.runtime.AnnotationSugar: Gatherers all annotations annotating a provided Method.
annotations(Method) - Static method in class org.refcodes.runtime.ReflectionUtility: Gatherers all annotations annotating a provided Method.
AnnotationSugar - Class in org.refcodes.runtime: Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for Annotation related functionality.
AnnotationSugar() - Constructor for class org.refcodes.runtime.AnnotationSugar
APPLICATION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies an application specific granularity.
APPLICATION_ALL - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of all the APPLICATION_* folders.
APPLICATION_DIR - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_DIR_ALL - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of all the APPLICATION_DIR_* folders as of the ConfigLocator enumeration.
APPLICATION_DIR_CONFIG - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the config folder relative to the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_DIR_DOT_CONFIG - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .config folder relative to the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_DIR_DOT_ETC - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .etc folder relative to the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_DIR_DOT_SETTINGS - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .settings folder relative to the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_DIR_ETC - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the etc folder relative to the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_DIR_SETTINGS - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the settings folder relative to the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_PARENT_ALL - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of all the APPLICATION_PARRENT_* folders as of the ConfigLocator enumeration.
APPLICATION_PARENT_CONFIG - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the config folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_PARENT_DOT_CONFIG - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .config folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_PARENT_DOT_ETC - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .etc folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_PARENT_DOT_SETTINGS - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .settings folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_PARENT_ETC - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the etc folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_PARENT_SETTINGS - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the settings folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
APPLICATION_SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session and an application specific granularity.
asDump(Object) - Static method in class org.refcodes.runtime.DumpBuilder: Dumps the the provided object into a Map which is returned as result (the builder needs not to be instantiated).
asNormalized(String, char) - Static method in class org.refcodes.runtime.PropertyBuilder: Normalizes the provided text.

C

ConfigLocator - Enum Class in org.refcodes.runtime: This enumeration represents configuration folder locations (of type File) and configuration file retrieval as of the chosen configuration mode.
containsDir(File, List<File>...) - Static method in class org.refcodes.runtime.RuntimeUtility
Correlation - Enum Class in org.refcodes.runtime: The Correlation assigns an according (as of the enumeration) Correlation-TID to the invoking process, this TID is used in log files and is part of the process's request or response pay-load in order to track process execution throughout a JVM.
CTRL_C_SIGNAL - Static variable in class org.refcodes.runtime.RuntimeUtility
CYGWIN - Enum constant in enum class org.refcodes.runtime.Terminal

D

DEFAULT - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Any of ConfigLocator.USER_WORKING_DIRECTORY, ConfigLocator.APPLICATION_DIR, ConfigLocator.APPLICATION_DIR_SETTINGS, ConfigLocator.APPLICATION_DIR_ETC, ConfigLocator.APPLICATION_DIR_CONFIG, ConfigLocator.USER_HOME_DOT_CONFIG or ConfigLocator.HOST_ETC in this precedence.
disableRequestCorrelation() - Method in interface org.refcodes.runtime.RequestCorrelation: Disables the automatic Request-Correlation mechanism.
disableSessionCorrelation() - Method in interface org.refcodes.runtime.SessionCorrelation: Disables the automatic Session-Correlation mechanism.
DumpBuilder - Class in org.refcodes.runtime: The DumpBuilder assists you in inspecting the content of an object.
DumpBuilder() - Constructor for class org.refcodes.runtime.DumpBuilder

E

enableRequestCorrelation() - Method in interface org.refcodes.runtime.RequestCorrelation: Enables the automatic Request-Correlation mechanism.
enableSessionCorrelation() - Method in interface org.refcodes.runtime.SessionCorrelation: Enables the automatic Session-Correlation mechanism.
EnvironmentUtility - Class in org.refcodes.runtime: Utility class with helpful methods for working with a system's environment variables.
exec(int, String) - Static method in class org.refcodes.runtime.SystemUtility: Executes a command and returns the output.
exec(int, String...) - Static method in class org.refcodes.runtime.SystemUtility: Executes a command and returns the output.
exec(String) - Static method in class org.refcodes.runtime.SystemUtility: Executes a command and returns the output.
exec(String...) - Static method in class org.refcodes.runtime.SystemUtility: Executes a command and returns the output.

F

findAnnotation(Class<? extends Annotation>, Class<?>) - Static method in class org.refcodes.runtime.AnnotationSugar: Seeks for an Annotation of the given type annotating a provided Class, also reckoning annotations nested inside annotations (recursively).
findAnnotation(Class<? extends Annotation>, Class<?>) - Static method in class org.refcodes.runtime.ReflectionUtility: Seeks for an Annotation of the given type annotating a provided Class, also reckoning annotations nested inside annotations (recursively).
findAnnotation(Class<? extends Annotation>, Object) - Static method in class org.refcodes.runtime.AnnotationSugar: Seeks for an Annotation of the given type annotating a provided Object, also reckoning annotations nested inside annotations (recursively).
findAnnotation(Class<? extends Annotation>, Object) - Static method in class org.refcodes.runtime.ReflectionUtility: Seeks for an Annotation of the given type annotating a provided Object, also reckoning annotations nested inside annotations (recursively).
findAnnotation(Class<? extends Annotation>, Field) - Static method in class org.refcodes.runtime.AnnotationSugar: Seeks for an Annotation of the given type annotating a provided Field, also reckoning annotations nested inside annotations (recursively).
findAnnotation(Class<? extends Annotation>, Field) - Static method in class org.refcodes.runtime.ReflectionUtility: Seeks for an Annotation of the given type annotating a provided Field, also reckoning annotations nested inside annotations (recursively).
findAnnotation(Class<? extends Annotation>, Method) - Static method in class org.refcodes.runtime.AnnotationSugar: Seeks for an Annotation of the given type annotating a provided Method, also reckoning annotations nested inside annotations (recursively).
findAnnotation(Class<? extends Annotation>, Method) - Static method in class org.refcodes.runtime.ReflectionUtility: Seeks for an Annotation of the given type annotating a provided Method, also reckoning annotations nested inside annotations (recursively).

G

getCallerStackTraceElement() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the StackTraceElement belonging to the direct caller of this method.
getCallerStackTraceElement(Class<?>) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the StackTraceElement belonging to the caller of the callee.
getCallerStackTraceElement(Class<?>...) - Static method in class org.refcodes.runtime.RuntimeUtility: Same as RuntimeUtility.getCallerStackTraceElement(Class) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
getCallerStackTraceElement(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the StackTraceElement belonging to the caller of the callee.
getCallerStackTraceElement(StackTraceElement...) - Static method in class org.refcodes.runtime.RuntimeUtility: Same as RuntimeUtility.getCallerStackTraceElement(StackTraceElement) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
getCallerStackTraceElement(String) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the StackTraceElement belonging to the caller of the callee.
getCallerStackTraceElement(String...) - Static method in class org.refcodes.runtime.RuntimeUtility: Same as RuntimeUtility.getCallerStackTraceElement(String) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
getCallerType() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the type of the (Class) belonging to the direct caller of this method.
getCallerType(Class<?>) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the type of the (Class) belonging to the caller of the callee.
getCallerType(Class<?>...) - Static method in class org.refcodes.runtime.RuntimeUtility: Same as RuntimeUtility.getCallerType(Class) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
getCallerType(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the type of the (Class) belonging to the caller of the callee.
getCallerType(StackTraceElement...) - Static method in class org.refcodes.runtime.RuntimeUtility: Same as RuntimeUtility.getCallerType(StackTraceElement) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
getCallerType(String) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the type of the (Class) belonging to the caller of the callee.
getCallerType(String...) - Static method in class org.refcodes.runtime.RuntimeUtility: Same as RuntimeUtility.getCallerType(String) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
getComputerName() - Static method in class org.refcodes.runtime.SystemUtility: Determines the computer's name.
getCurrentTerminalHeight() - Static method in enum class org.refcodes.runtime.Terminal: Determines the current height in characters of the system's terminal in use.
getCurrentTerminalWidth() - Static method in enum class org.refcodes.runtime.Terminal: Determines the current width in characters of the system's terminal in use.
getEnvironmentVariable(String) - Method in class org.refcodes.runtime.PropertyBuilder: Returns the according environment variable after having converted the provided key to an environment variable.
getFolders() - Method in enum class org.refcodes.runtime.ConfigLocator: Returns the folders to be examined by the according enumeration's configuration in the order as of evaluation.
getFolders(File...) - Method in enum class org.refcodes.runtime.ConfigLocator: Returns the folders to be examined by the according enumeration's configuration in the order as of evaluation.
getId() - Method in enum class org.refcodes.runtime.Correlation: Retrieves the Correlation-TID assigned to the current Thread.
getKey() - Method in class org.refcodes.runtime.PropertyBuilder
getLineBreak() - Static method in enum class org.refcodes.runtime.Terminal: Determines the operating system as of toOperatingSystem() and in case a WINDOWS is being detected, then \r\n" (CRLF) is returned, else "\n" (LF) is returned.
getMainClass() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the main class launching the application.
getObject() - Method in class org.refcodes.runtime.DumpBuilder
getPid() - Static method in class org.refcodes.runtime.RuntimeUtility: Bad hack to get the JVM's (process TID) PID of the process running your JVM instance.
getResult() - Method in class org.refcodes.runtime.ProcessResult
getSystemProperty(String) - Method in class org.refcodes.runtime.PropertyBuilder: Returns the according system's property after having converted the provided key to a system property.
getTerminalEncoding() - Static method in enum class org.refcodes.runtime.Terminal: Determines the encoding of the system (system's console) in use as of System.out.
getTerminalHeight() - Static method in enum class org.refcodes.runtime.Terminal: Determines the height in characters of the system's terminal in use.
getTerminalHeight(int) - Static method in enum class org.refcodes.runtime.Terminal: Determines the height in characters of the system's terminal in use.
getTerminalWidth() - Static method in enum class org.refcodes.runtime.Terminal: Determines the width in characters of the system's terminal in use.
getTerminalWidth(int) - Static method in enum class org.refcodes.runtime.Terminal: Determines the width in characters of the system's terminal in use.
getUname() - Static method in class org.refcodes.runtime.SystemUtility: If on a *nix alike system, this method returns the output of the "uname -a" command: "uname" prints system information, "-a" instructs it to print all information.
getVersion() - Method in enum class org.refcodes.runtime.OperatingSystem: Tries at best will to get a version number of the currently operating OS.

H

hasAnnotation(Class<? extends Annotation>, Class<?>) - Static method in class org.refcodes.runtime.AnnotationSugar: Tests if an Annotation of the given type annotates a provided Class, also reckoning annotations nested inside annotations (recursively).
hasAnnotation(Class<? extends Annotation>, Class<?>) - Static method in class org.refcodes.runtime.ReflectionUtility: Tests if an Annotation of the given type annotates a provided Class, also reckoning annotations nested inside annotations (recursively).
hasAnnotation(Class<? extends Annotation>, Object) - Static method in class org.refcodes.runtime.AnnotationSugar: Tests if an Annotation of the given type annotates a provided Object, also reckoning annotations nested inside annotations (recursively).
hasAnnotation(Class<? extends Annotation>, Object) - Static method in class org.refcodes.runtime.ReflectionUtility: Tests if an Annotation of the given type annotates a provided Object, also reckoning annotations nested inside annotations (recursively).
hasAnnotation(Class<? extends Annotation>, Field) - Static method in class org.refcodes.runtime.AnnotationSugar: Tests if an Annotation of the given type annotates a provided Field, also reckoning annotations nested inside annotations (recursively).
hasAnnotation(Class<? extends Annotation>, Field) - Static method in class org.refcodes.runtime.ReflectionUtility: Tests if an Annotation of the given type annotates a provided Field, also reckoning annotations nested inside annotations (recursively).
hasAnnotation(Class<? extends Annotation>, Method) - Static method in class org.refcodes.runtime.AnnotationSugar: Tests if an Annotation of the given type annotates a provided Method, also reckoning annotations nested inside annotations (recursively).
hasAnnotation(Class<? extends Annotation>, Method) - Static method in class org.refcodes.runtime.ReflectionUtility: Tests if an Annotation of the given type annotates a provided Method, also reckoning annotations nested inside annotations (recursively).
hasAnyCorrelationId() - Static method in enum class org.refcodes.runtime.Correlation: Evaluates whether any of the given Correlation-IDs is present (not null).
hasGetterAttribute(Object, String, Class<?>) - Static method in class org.refcodes.runtime.ReflectionUtility: This method tests whether the given java beans getter attribute is found for the given object.
hasRequestCorrelation() - Method in interface org.refcodes.runtime.RequestCorrelation: Determines whether Request-Correlation is being enabled or disabled.
hasResult() - Method in class org.refcodes.runtime.ProcessResult
hasSessionCorrelation() - Method in interface org.refcodes.runtime.SessionCorrelation: Determines whether Session-Correlation is being enabled or disabled.
hasSetterAttribute(Object, String, Class<?>) - Static method in class org.refcodes.runtime.ReflectionUtility: This method tests whether the given java beans setter attribute is found for the given object.
HOST - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a host specific granularity.
HOST_APPLICATION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies an application on a host specific granularity.
HOST_APPLICATION_SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session for an application on a host specific granularity.
HOST_ETC - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the (in Unix alike systems) /etc/ folder.
HOST_SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session for a host specific granularity.
HOST_USER - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a user on a host specific granularity.
HOST_USER_APPLICATION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies an application for a user on a host specific granularity.
HOST_USER_APPLICATION_SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session for an application for a user on a host specific granularity.
HOST_USER_SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session for a user on a host specific granularity.

I

isAnsiTerminal() - Static method in enum class org.refcodes.runtime.Terminal: Determines whether ANSI escape sequences are supported by the terminal.
isAnsiTerminalPreferred() - Static method in enum class org.refcodes.runtime.Terminal: Determines whether ANSI escape sequences are forced to be supported or not by REFCODES.ORG artifacts.
isApplicationBase() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's base (the folder where the JAR resides) folder.
isApplicationBaseConfig() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's base (the folder where the JAR resides) "config" subfolder.
isApplicationBaseDotConfig() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's base (the folder where the JAR resides) ".config" subfolder.
isApplicationBaseDotEtc() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's base (the folder where the JAR resides) ".etc" subfolder.
isApplicationBaseDotSettings() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's base (the folder where the JAR resides) ".settings" subfolder.
isApplicationBaseEtc() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's base (the folder where the JAR resides) "etc" subfolder.
isApplicationBaseSettings() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's base (the folder where the JAR resides) "settings" subfolder.
isApplicationLevel() - Method in enum class org.refcodes.runtime.SystemContext: Determines whether the granularity is on an application level.
isApplicationParentConfig() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "config" subfolder.
isApplicationParentDotConfig() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".config" subfolder.
isApplicationParentDotEtc() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".etc" subfolder.
isApplicationParentDotSettings() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".settings" subfolder.
isApplicationParentEtc() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "etc" subfolder.
isApplicationParentSettings() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "settings" subfolder.
isCurrentlyLineBreakRequired(int) - Static method in enum class org.refcodes.runtime.Terminal: Determines whether we need an explicit line-break for the given width on the current operating system and used terminal.
isHostEtc() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the host's "/etc" folder.
isHostLevel() - Method in enum class org.refcodes.runtime.SystemContext: Determines whether the granularity is on a host level.
isLineBreakRequired(int) - Static method in enum class org.refcodes.runtime.Terminal: Determines whether we need an explicit line-break for the given width on the current operating system and used terminal.
isLineBreakRequired(int, int) - Static method in enum class org.refcodes.runtime.Terminal: Determines whether we need an explicit line-break for the given width on the current operating system and used terminal.
isSessionLevel() - Method in enum class org.refcodes.runtime.SystemContext: Determines whether the granularity is on a session level, e.g. valid just for the lifetime of the current runtime Java's invocation.
isUnderTest() - Static method in class org.refcodes.runtime.RuntimeUtility: Determines whether this code is executed from inside a unit test or not.
isUserHome() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's home "~" folder.
isUserHomeConfig() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's home "~" subfolder "config".
isUserHomeDotConfig() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's home "~" subfolder ".config".
isUserHomeDotEtc() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's home "~" subfolder ".etc".
isUserHomeDotSettings() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's home "~" subfolder ".settings".
isUserHomeEtc() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's home "~" subfolder "etc".
isUserHomeSettings() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's home "~" subfolder "settings".
isUserLevel() - Method in enum class org.refcodes.runtime.SystemContext: Determines whether the granularity is on a user level.
isUserWorkingDir() - Method in enum class org.refcodes.runtime.ConfigLocator: Determines whether to consider the user's current working directory (as for example bash's pwd would print out).

K

kill(Long) - Static method in class org.refcodes.runtime.RuntimeUtility: Bad hack to kill an OS thread by PID.
killProcess(long) - Static method in class org.refcodes.runtime.RuntimeUtility: Bad hack to kill an OS thread by PID.

M

MAC - Enum constant in enum class org.refcodes.runtime.OperatingSystem

N

nextId() - Method in enum class org.refcodes.runtime.Correlation: Creates a new Correlation-TID no matter whether there is a Correlation-TID already assigned to the current thread or not.
NON_EXISTING_VALUE - Static variable in class org.refcodes.runtime.ReflectionUtility
NONE - Enum constant in enum class org.refcodes.runtime.Shell
NonExistingValueClass() - Constructor for class org.refcodes.runtime.ReflectionUtility.NonExistingValueClass

O

OperatingSystem - Enum Class in org.refcodes.runtime: Enumeration with the (supported) operating systems.
org.refcodes.runtime - module org.refcodes.runtime
org.refcodes.runtime - package org.refcodes.runtime: This package contains runtime related interfaces and enumerations.

P

POWER_SHELL - Enum constant in enum class org.refcodes.runtime.Shell: MS Windows PowerShell:.
ProcessResult - Class in org.refcodes.runtime: Retrieves the Result of the given process as String.
ProcessResult(Process) - Constructor for class org.refcodes.runtime.ProcessResult: Constructs a ProcessResult instance which will synchronously return the process' result via ProcessResult.getResult() (and ProcessResult.toString() accordingly).
ProcessResult(Process, int) - Constructor for class org.refcodes.runtime.ProcessResult: Constructs a ProcessResult instance which will synchronously return the process' result via ProcessResult.getResult() (and ProcessResult.toString() accordingly).
PropertyBuilder - Class in org.refcodes.runtime: Converts a key to the format of a system property (camel-case) or an environment variable (snake-case in upper-case).
PropertyBuilder() - Constructor for class org.refcodes.runtime.PropertyBuilder
pullId() - Method in enum class org.refcodes.runtime.Correlation: Returns a Correlation-TID in any case: Creates a new Correlation-TID in case there is none yet for the current thread.
putProperty(Map<String, String>, String, String, char) - Static method in class org.refcodes.runtime.RuntimeUtility: Puts a property and resolves the key in case of name collisions.

R

ReflectionUtility - Class in org.refcodes.runtime: The Class ReflectionUtility.
ReflectionUtility.NonExistingValueClass - Class in org.refcodes.runtime: This class indicates a non existing value in the name-to-value mapping.
REQUEST - Enum constant in enum class org.refcodes.runtime.Correlation: A single request spanning over multiple systems.
RequestCorrelation<B extends RequestCorrelation<B>> - Interface in org.refcodes.runtime: Provides methods to set Request-Correlation behavior: When enabled via RequestCorrelation.setRequestCorrelation(boolean) (or the like), then an existing Request-Correlation-TID might be forwarded by setting it into the Correlation singleton via Correlation.REQUEST's Correlation.setId(String).
RuntimeUtility - Class in org.refcodes.runtime: Utility for acquiring runtime information on software systems, classes or objects.

S

SESSION - Enum constant in enum class org.refcodes.runtime.Correlation: Identifying a session for multiple requests spanning over multiple systems. traced.
SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session specific granularity, valid just for the current invocation of the Java runtime.
SessionCorrelation<B extends SessionCorrelation<B>> - Interface in org.refcodes.runtime: Provides methods to set Session-Correlation behavior: When enabled via SessionCorrelation.setSessionCorrelation(boolean) (or the like), then an existing Session-Correlation-TID might be forwarded by setting it into the Correlation singleton via Correlation.SESSION's Correlation.setId(String).
setAttribute(Object, String, Object) - Static method in class org.refcodes.runtime.ReflectionUtility: This method sets a java beans attribute for the given object.
setAttribute(Object, Attribute) - Static method in class org.refcodes.runtime.ReflectionUtility: This method sets a java beans attribute for the given object.
setId(String) - Method in enum class org.refcodes.runtime.Correlation: Assigns the given Correlation-TID to the current Thread.
setKey(String) - Method in class org.refcodes.runtime.PropertyBuilder
setLoggingHandler(Handler) - Static method in class org.refcodes.runtime.RuntimeUtility: Redirects the Logger configuration and sets the provided handler.
setLoggingStreams(OutputStream, OutputStream, Level) - Static method in class org.refcodes.runtime.RuntimeUtility: Redirects the Logger configuration to the provided streams.
setObject(Object) - Method in class org.refcodes.runtime.DumpBuilder
setRequestCorrelation(boolean) - Method in interface org.refcodes.runtime.RequestCorrelation: Enables or disables the automatic Request-Correlation mechanism.
setSessionCorrelation(boolean) - Method in interface org.refcodes.runtime.SessionCorrelation: Enables or disables the automatic Session-Correlation mechanism.
Shell - Enum Class in org.refcodes.runtime: Enumeration with the (relevant) shells (command line interpreters).
SHELL - Enum constant in enum class org.refcodes.runtime.Shell: Unix / Linux / BSD like shell.
SystemContext - Enum Class in org.refcodes.runtime: Describes the context within a system's environment regarding host, user and application contexts as well as the currently invoked Java runtime session.
SystemUtility - Class in org.refcodes.runtime: Utility for acquiring system information on the machine this process is running in.

T

Terminal - Enum Class in org.refcodes.runtime: Enumeration with the (relevant) terminals as well as interpolated terminal metrics.
toAbsolutePathFromEnvironment(String, String...) - Static method in class org.refcodes.runtime.EnvironmentUtility: This method converts a relative path to an absolute path relative to the path specified in the first system property provided being set with a value.
toAbsoluteUserHomePath(String) - Static method in class org.refcodes.runtime.EnvironmentUtility: This method converts a relative path to an absolute path relative to the user's home folder.
toBeanAttributes(Object) - Static method in class org.refcodes.runtime.ReflectionUtility: This method uses reflection on order to analyze a given object.
toBestCallerStackTraceElement(Class<?>) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the best matching StackTraceElement belonging to the caller of the callee.The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
toBestCallerStackTraceElement(Class<?>[]) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the best matching StackTraceElement belonging to the caller of one of the callees (in the order passed to the method).The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
toBestCallerStackTraceElement(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the best matching StackTraceElement belonging to the caller of the callee.The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
toBestCallerStackTraceElement(StackTraceElement[]) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the best matching StackTraceElement belonging to the caller of one of the callees (in the order passed to the method).The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
toBestCallerStackTraceElement(String) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the best matching StackTraceElement belonging to the caller of the callee.
toBestCallerStackTraceElement(String[]) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the best matching StackTraceElement belonging to the caller of one of the callees (in the order passed to the method).The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
toBootstrapStandardError() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the original PrintStream for STDERR as initialized by the JVM at bootstrapping time (the System.err PrintStream may have got modified by libraries or frameworks in the meanwhile).
toBootstrapStandardIn() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the original InputStream for STDIN as initialized by the JVM at bootstrapping time (the System.in InputStream may have got modified by libraries or frameworks in the meanwhile).
toBootstrapStandardOut() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the original PrintStream for STDOUT as initialized by the JVM at bootstrapping time (the System.out PrintStream may have got modified by libraries or frameworks).
toClass(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the Class type to which the StackTraceElement belongs.
toClassName() - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the class name of the caller of this method without the fully qualified package name part.
toClassName(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the class name part from a StackTraceElement.
toClassName(String) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the class name part from a fully qualified class name (which has the fully qualified package name as part of its name).
toClone(T) - Static method in class org.refcodes.runtime.RuntimeUtility: A Cloneable object cannot directly be cloned by casting it to be Cloneable :-( Thereforee this method does the job.
toContextId() - Method in enum class org.refcodes.runtime.SystemContext: Creates an TID most probably unique as specified by the enumeration instance this method is invoked on.
toContextId(String) - Method in enum class org.refcodes.runtime.SystemContext: Creates an TID most probably unique as specified by the enumeration instance this method is invoked on.
toContextIds(int) - Method in enum class org.refcodes.runtime.SystemContext: Creates an array of IDs most probably unique as specified by the provided argument this method is invoked on.
toContextIds(int, String) - Method in enum class org.refcodes.runtime.SystemContext: Creates an array of IDs most probably unique as specified by the provided argument this method is invoked on.
toContextSequence() - Method in enum class org.refcodes.runtime.SystemContext: Creates a String most probably unique as specified by the enumeration instance this method is invoked on.
toContextSequence(char[]) - Method in enum class org.refcodes.runtime.SystemContext: Creates a String most probably unique as specified by the enumeration instance this method is invoked on.
toContextSequence(String) - Method in enum class org.refcodes.runtime.SystemContext: Creates a String most probably unique as specified by the enumeration instance this method is invoked on.
toContextString() - Method in enum class org.refcodes.runtime.SystemContext: Creates a String most probably unique as specified by the enumeration instance this method is invoked on.
toContextString(char[]) - Method in enum class org.refcodes.runtime.SystemContext: Creates a String most probably unique as specified by the enumeration instance this method is invoked on.
toContextString(String) - Method in enum class org.refcodes.runtime.SystemContext: Creates a String most probably unique as specified by the enumeration instance this method is invoked on.
toDump() - Method in class org.refcodes.runtime.DumpBuilder: Dumps the state of the contained object (as of DumpBuilder.setObject(Object)) into a Map which is returned as result.
toDump(Object) - Method in class org.refcodes.runtime.DumpBuilder: Dumps the state of the provided object into a Map which is returned as result.
toDump(Object, Map<String, String>) - Static method in class org.refcodes.runtime.DumpBuilder: Dumps the state of the implementing instance into the provided Map which is returned as result.
toEnvironmentVariable() - Method in class org.refcodes.runtime.PropertyBuilder: Converts the key as of PropertyBuilder.getKey() to an environment variable.
toEnvironmentVariable(String) - Method in class org.refcodes.runtime.PropertyBuilder: Converts the provided key to an environment variable.
toFile(String) - Method in enum class org.refcodes.runtime.ConfigLocator: Retrieves the first File identified by the given filename located in one of the according enumeration's configuration locations.
toFile(String, File...) - Method in enum class org.refcodes.runtime.ConfigLocator: Retrieves the first File identified by the given filename located in one of the according enumeration's configuration locations.
toFormatted(String, Object...) - Static method in class org.refcodes.runtime.RuntimeUtility: Wraps MessageFormat.format(String, Object...) to prevent failing when message cannot be formatted.
toFullCorrelationId() - Static method in enum class org.refcodes.runtime.Correlation: Returns a String with all Correlation-IDs found separated by a Delimiter.CORRELATION_ID character from each other.
toFullyQualifiedClassName() - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the fully qualified method name of the caller of this method.
toFullyQualifiedClassName(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the fully qualified class name from a StackTraceElement.
toFullyQualifiedMethodName() - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the fully qualified method name of the caller of this method.
toFullyQualifiedMethodName(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the fully qualified method name from a StackTraceElement.
toFullyQualifiedPackageName() - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the fully qualified package name of the caller of this method without the class name part.
toFullyQualifiedPackageName(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the fully qualified package name from a StackTraceElement.
toFullyQualifiedPackageName(String) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the fully qualified package name part from a fully qualified class name (which has the fully qualified package name as part of its name).
toHostIpAddress() - Static method in class org.refcodes.runtime.SystemUtility: Tries to determine a no-localhost IP-Address for this machine.
toHostMacAddress() - Static method in class org.refcodes.runtime.SystemUtility: Tries to determine the host Mac-Address for this machine.
toLauncherDir() - Static method in class org.refcodes.runtime.RuntimeUtility: Generates the base path relative to the given class location.
toLineBreak(int) - Static method in enum class org.refcodes.runtime.Terminal: Uses Terminal.isLineBreakRequired(int) to retrieve the character sequence required to suffix to a line in order to get a line break without risking any empty lines as of automatic line wrapping.
toMethodName() - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the fully qualified method name of the caller of this method.
toMethodName(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility: Retrieves the method name from a StackTraceElement.
toNextKey(Map<String, String>, String, char) - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the next free key in the properties in case of key name collisions..
toOperatingSystem() - Static method in enum class org.refcodes.runtime.OperatingSystem: Determines the operating system your application is currently running on.
toOption(String, String...) - Static method in class org.refcodes.runtime.RuntimeUtility: When the provided argument starts with one of the provided prefixes, then the portion of the argument without the prefix is returned, which represents the option in question.
toPath() - Method in class org.refcodes.runtime.PropertyBuilder: Converts the key as of PropertyBuilder.getKey() to a path (as of PathMap).
toPath(String) - Method in class org.refcodes.runtime.PropertyBuilder: Converts the provided key as of PropertyBuilder.getKey() to a path (as of PathMap).
toPlatformSpecificPath(String) - Static method in class org.refcodes.runtime.EnvironmentUtility: This method concerts the given path to a platform specific path, mainly replacing the path separator accordingly.
toPreferredTerminalHeight() - Static method in enum class org.refcodes.runtime.Terminal: Does some calculation to always return a sound console height (never returns -1).
toPreferredTerminalWidth() - Static method in enum class org.refcodes.runtime.Terminal: Does some calculation to always return a sound console width (never returns -1).
toPrettySystemInfo() - Static method in class org.refcodes.runtime.SystemUtility: Gathers all available system information from this Artifac's point of view.
toProperties(String[]) - Static method in class org.refcodes.runtime.RuntimeUtility: Creates a Map from the provided command line arguments using the ArgsPrefix.toPrefixes() prefixes to identify the keys (and the values) from the provided arguments.
toProperties(String[], String[], char) - Static method in class org.refcodes.runtime.RuntimeUtility: Creates a Map from the provided command line arguments using the provided prefixes to identify the keys (and the values) from the provided arguments.
toProperties(String[], Collection<String>, char) - Static method in class org.refcodes.runtime.RuntimeUtility: Creates a Map from the provided command line arguments using the provided prefixes to identify the keys (and the values) from the provided arguments.
toPropertyValue(String, SystemProperty, EnvironmentVariable...) - Static method in class org.refcodes.runtime.SystemUtility: Gets the value for the provided properties, if non was found then the default value is taken.
toPropertyValue(SystemProperty, EnvironmentVariable...) - Static method in class org.refcodes.runtime.SystemUtility: Gets the value for the provided properties, if non was found then null is returned.
toShell() - Static method in enum class org.refcodes.runtime.Shell: Tries to determine the command line interpreter (CLI) - if any - this process is running in, e.g. whether we are running in a DOS console environment or a Linux alike Shell.
toStackTrace() - Static method in class org.refcodes.runtime.RuntimeUtility: Gets the stack trace for the current thread.
toString() - Method in class org.refcodes.runtime.ProcessResult
toString(String, String) - Static method in class org.refcodes.runtime.RuntimeUtility: Creates a string of a super class's Object.toString() method and the provided "toString" text.
toSystemErr() - Static method in class org.refcodes.runtime.RuntimeUtility: Create a PrintStream from System.err being UTF-8 encoded and filtering out ANSI escape codes in case the underlying terminal does not support the such.
toSystemInfo() - Static method in class org.refcodes.runtime.SystemUtility: Gathers all available system information from this Artifac's point of view.
toSystemOut() - Static method in class org.refcodes.runtime.RuntimeUtility: Create a PrintStream from System.out being UTF-8 encoded and filtering out ANSI escape codes in case the underlying terminal does not support the such.
toSystemProperty() - Method in class org.refcodes.runtime.PropertyBuilder: Converts the key as of PropertyBuilder.getKey() to a system property.
toSystemProperty(String) - Method in class org.refcodes.runtime.PropertyBuilder: Converts the provided key to a system property.
toTerminal() - Static method in enum class org.refcodes.runtime.Terminal: Determines the terminal your application is currently in.
toUserWorkingDir() - Static method in class org.refcodes.runtime.RuntimeUtility: Tries to determine the current directory from which the Java programm was started for example as of bash's pwd command.

U

UNIX - Enum constant in enum class org.refcodes.runtime.OperatingSystem: Unix / Linux / BSD like operating system.
UNKNOWN - Enum constant in enum class org.refcodes.runtime.OperatingSystem: Unknown operating system.
UNKNOWN - Enum constant in enum class org.refcodes.runtime.Shell
UNKNOWN - Enum constant in enum class org.refcodes.runtime.Terminal
USER - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a user specific granularity.
USER_APPLICATION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a user specific granularity.
USER_APPLICATION_SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session and a user specific granularity.
USER_HOME - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the executing user's home folder.
USER_HOME_ALL - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of all the USER_HOME_* folders.
USER_HOME_CONFIG - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the config folder relative to the executing user's home folder.
USER_HOME_DOT_CONFIG - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .config folder relative to the executing user's home folder.
USER_HOME_DOT_ETC - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .etc folder relative to the executing user's home folder.
USER_HOME_DOT_SETTINGS - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the .settings folder relative to the executing user's home folder.
USER_HOME_ETC - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the etc folder relative to the executing user's home folder.
USER_HOME_SETTINGS - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of the settings folder relative to the executing user's home folder.
USER_HOME_WORKING_DIRECTORY_ALL - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Representation of all the USER_HOME_* folders as well as the current user's current working directory USER_WORKING_DIRECTORY.
USER_SESSION - Enum constant in enum class org.refcodes.runtime.SystemContext: Specifies a Java runtime invokcation's session for a user specific granularity.
USER_WORKING_DIRECTORY - Enum constant in enum class org.refcodes.runtime.ConfigLocator: Consider just the current user's current working directory.

V

valueOf(String) - Static method in enum class org.refcodes.runtime.ConfigLocator: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.refcodes.runtime.Correlation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.refcodes.runtime.OperatingSystem: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.refcodes.runtime.Shell: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.refcodes.runtime.SystemContext: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.refcodes.runtime.Terminal: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.refcodes.runtime.ConfigLocator: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.refcodes.runtime.Correlation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.refcodes.runtime.OperatingSystem: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.refcodes.runtime.Shell: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.refcodes.runtime.SystemContext: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.refcodes.runtime.Terminal: Returns an array containing the constants of this enum class, in the order they are declared.

W

WIN_CMD - Enum constant in enum class org.refcodes.runtime.Shell: MS Windows WIN_CMD.EXE
WINDOWS - Enum constant in enum class org.refcodes.runtime.OperatingSystem
withDisableRequestCorrelation() - Method in interface org.refcodes.runtime.RequestCorrelation: Builder method for the RequestCorrelation.disableRequestCorrelation() operation.
withDisableSessionCorrelation() - Method in interface org.refcodes.runtime.SessionCorrelation: Builder method for the SessionCorrelation.disableSessionCorrelation() operation.
withEnableRequestCorrelation() - Method in interface org.refcodes.runtime.RequestCorrelation: Builder method for the RequestCorrelation.enableRequestCorrelation() operation.
withEnableSessionCorrelation() - Method in interface org.refcodes.runtime.SessionCorrelation: Builder method for the SessionCorrelation.enableSessionCorrelation() operation.
withKey(String) - Method in class org.refcodes.runtime.PropertyBuilder
withObject(Object) - Method in class org.refcodes.runtime.DumpBuilder
withRequestCorrelation(boolean) - Method in interface org.refcodes.runtime.RequestCorrelation: Builder method for the RequestCorrelation.setRequestCorrelation(boolean) operation.
withSessionCorrelation(boolean) - Method in interface org.refcodes.runtime.SessionCorrelation: Builder method for the SessionCorrelation.setSessionCorrelation(boolean) operation.

X

XTERM - Enum constant in enum class org.refcodes.runtime.Terminal

A C D E F G H I K M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values