Skip navigation links
A C D E G H I K N O P R S T V W 

A

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
 

C

containsDir(File, List<File>...) - Static method in class org.refcodes.runtime.RuntimeUtility
 
Correlation - Enum in org.refcodes.runtime
The Correlation assigns an according (as of the enumeration) Correlation-ID to the invoking process, this ID 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.

D

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 - Interface in org.refcodes.runtime
The DumpBuilder assists you in inspecting the content of an object.
DumpBuilderImpl - Class in org.refcodes.runtime
TODO: Extend the toDump(Object, Map) wit a List if visited objects and a "nested"-counter and dig recursively into the object.
DumpBuilderImpl() - Constructor for class org.refcodes.runtime.DumpBuilderImpl
 

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(String) - Static method in class org.refcodes.runtime.SystemUtility
Executes a command and returns the output.

G

getCallerStackTraceElement() - Static method in class org.refcodes.runtime.RuntimeUtility
Returns the stack trace element belonging to the direct caller of this method.
getCallerStackTraceElement(Class<?>) - Static method in class org.refcodes.runtime.RuntimeUtility
Returns the stack trace element 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(String) - Static method in class org.refcodes.runtime.RuntimeUtility
Returns the stack trace element 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.
getComputerName() - Static method in class org.refcodes.runtime.SystemUtility
Determines the computer's name.
getEnvironmentVariable() - Method in interface org.refcodes.runtime.PropertyBuilder
Returns the according environment variable after having converted the key as of KeyAccessor.getKey() to an environment variable.
getEnvironmentVariable(String) - Method in interface org.refcodes.runtime.PropertyBuilder
Returns the according environment variable after having converted the provided key to an environment variable.
getEnvironmentVariable(String) - Method in class org.refcodes.runtime.PropertyBuilderImpl
Returns the according environment variable after having converted the provided key to an environment variable.
getId() - Method in enum org.refcodes.runtime.Correlation
Retrieves the Correlation-ID assigned to the current Thread.
getKey() - Method in class org.refcodes.runtime.PropertyBuilderImpl
getLineBreak() - Static method in class org.refcodes.runtime.SystemUtility
Determines the operating system as of OperatingSystem.toOperatingSystem() and in case a OperatingSystem.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.DumpBuilderImpl
getPid() - Static method in class org.refcodes.runtime.RuntimeUtility
Bad hack to get the JVM's (process ID) PID of the process running your JVM instance.
getSystemEncoding() - Static method in class org.refcodes.runtime.SystemUtility
Determines the encoding of the system (system's console) in use as of System.out.
getSystemProperty() - Method in interface org.refcodes.runtime.PropertyBuilder
Returns the according system's property after having converted the key as of KeyAccessor.getKey() to a system property.
getSystemProperty(String) - Method in interface org.refcodes.runtime.PropertyBuilder
Returns the according system's property after having converted the provided key to a system property.
getSystemProperty(String) - Method in class org.refcodes.runtime.PropertyBuilderImpl
Returns the according system's property after having converted the provided key to a system property.
getTempDir() - Static method in class org.refcodes.runtime.SystemUtility
Returns the operating saystem's temp folder.
getTerminalHeight() - Static method in class org.refcodes.runtime.SystemUtility
Determines the height in characters of the system's terminal in use.
getTerminalWidth() - Static method in class org.refcodes.runtime.SystemUtility
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.

H

hasAnyCorrelationId() - Static method in enum 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.
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.

I

isAnsiTerminal() - Static method in class org.refcodes.runtime.SystemUtility
Determines whether ANSI escape sequences are supported by the terminal.
isUseLineBreak(int) - Static method in class org.refcodes.runtime.SystemUtility
Determines whether wee need an explicit line-break for the given width on the current operating system and used terminal.

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.

N

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

O

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

P

PropertyBuilder - Interface 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).
PropertyBuilderImpl - Class in org.refcodes.runtime
The Class PropertyBuilderImpl.
PropertyBuilderImpl() - Constructor for class org.refcodes.runtime.PropertyBuilderImpl
 
pullId() - Method in enum org.refcodes.runtime.Correlation
Returns a Correlation-ID in any case: Creates a new Correlation-ID in case there is none yet for the current thread.

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.
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-ID 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

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-ID 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 org.refcodes.runtime.Correlation
Assigns the given Correlation-ID to the current Thread.
setKey(String) - Method in class org.refcodes.runtime.PropertyBuilderImpl
setObject(Object) - Method in class org.refcodes.runtime.DumpBuilderImpl
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 in org.refcodes.runtime
Enumeration with the (relevant) shells (command line interpreters).
SystemUtility - Class in org.refcodes.runtime
Utility for acquiring system information on the machine this process is running in.

T

Terminal - Enum in org.refcodes.runtime
Enumeration with the (relevant) terminals.
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.
toAnsiConsole() - Static method in class org.refcodes.runtime.SystemUtility
Determines whether ANSI escape sequences are forced to be supported or not by REFCODES.ORG artifacts.
toBeanAttributes(Object) - Static method in class org.refcodes.runtime.ReflectionUtility
This method uses reflection on order to analyze a given object.
toClass(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility
Retrieves the Class type to which the StackTraceElement belongs.
toClassName(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility
Returns the class name part from a stack trace element.
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(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.
toConfigDirs(File...) - Static method in class org.refcodes.runtime.RuntimeUtility
Returns a list of (existing) folders which are candidates for external resources.
toConfigDirs() - Static method in class org.refcodes.runtime.RuntimeUtility
The application's base directory (where your JAR or your classes reside) is taken using the folder as retrieved by RuntimeUtility.toLauncherDir() and passed to RuntimeUtility.toConfigDirs(File...).
toConfigDirs(File) - Static method in class org.refcodes.runtime.RuntimeUtility
The File representing the potential base directory together with the application's base directory where your JAR or your classes reside) is taken (using the folder as retrieved by RuntimeUtility.toLauncherDir()) and passed to RuntimeUtility.toConfigDirs(File...) and tested for application configuration folders.
toConsoleHeight() - Static method in class org.refcodes.runtime.SystemUtility
Does some calculation to always return a sound console height (never returns -1).
toConsoleWidth() - Static method in class org.refcodes.runtime.SystemUtility
Does some calculation to always return a sound console width (never returns -1).
toDump() - Method in interface org.refcodes.runtime.DumpBuilder
Dumps the state of the contained object (as of ObjectAccessor.ObjectMutator.setObject(Object)) into a Map which is returned as result.
toDump(Object) - Method in interface org.refcodes.runtime.DumpBuilder
Dumps the state of the provided object into a Map which is returned as result.
toDump(Object) - Method in class org.refcodes.runtime.DumpBuilderImpl
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.DumpBuilderImpl
Dumps the state of the implementing instance into the provided Map which is returned as result.
toEnvironmentVariable() - Method in interface org.refcodes.runtime.PropertyBuilder
Converts the key as of KeyAccessor.getKey() to an environment variable.
toEnvironmentVariable(String) - Method in interface org.refcodes.runtime.PropertyBuilder
Converts the provided key to an environment variable.
toEnvironmentVariable(String) - Method in class org.refcodes.runtime.PropertyBuilderImpl
Converts the provided key to an environment variable.
toFullCorrelationId() - Static method in enum org.refcodes.runtime.Correlation
Returns a String with all Correlation-IDs found separated by a Delimiter.CORRELATION_ID character from each other.
toFullyQualifiedClassName(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility
Retrieves the fully qualified class name from a stack trace element.
toFullyQualifiedClassName() - 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 stack trace element.
toFullyQualifiedMethodName() - Static method in class org.refcodes.runtime.RuntimeUtility
Retrieves the fully qualified method name of the caller of this method.
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 stack trace element.
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).
toLauncherDir() - Static method in class org.refcodes.runtime.RuntimeUtility
Generates the base path relative to the given class location.
toLineBreak(int) - Static method in class org.refcodes.runtime.SystemUtility
Uses SystemUtility.isUseLineBreak(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(StackTraceElement) - Static method in class org.refcodes.runtime.RuntimeUtility
Retrieves the method name from a stack trace element.
toMethodName() - Static method in class org.refcodes.runtime.RuntimeUtility
Retrieves the fully qualified method name of the caller of this method.
toNormalized(String, char) - Static method in class org.refcodes.runtime.PropertyBuilderImpl
 
toOperatingSystem() - Static method in enum org.refcodes.runtime.OperatingSystem
Determines the operating system your application is currently running on.
toPath() - Method in interface org.refcodes.runtime.PropertyBuilder
Converts the key as of KeyAccessor.getKey() to a path (as of PathMap).
toPath(String) - Method in interface org.refcodes.runtime.PropertyBuilder
Converts the provided key as of KeyAccessor.getKey() to a path (as of PathMap).
toPath(String) - Method in class org.refcodes.runtime.PropertyBuilderImpl
Converts the provided key as of KeyAccessor.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.
toPropertyValue(String, SystemProperty, EnvironmentProperty...) - 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, EnvironmentProperty...) - 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 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(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.
toSystemInfo() - Static method in class org.refcodes.runtime.SystemUtility
Prints out all available system information from this Artifac's point of view.
toSystemProperty() - Method in interface org.refcodes.runtime.PropertyBuilder
Converts the key as of KeyAccessor.getKey() to a system property.
toSystemProperty(String) - Method in interface org.refcodes.runtime.PropertyBuilder
Converts the provided key to a system property.
toSystemProperty(String) - Method in class org.refcodes.runtime.PropertyBuilderImpl
Converts the provided key to a system property.
toTerminal() - Static method in enum org.refcodes.runtime.Terminal
Determines the terminal your application is currently in.

V

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

W

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.PropertyBuilderImpl
withObject(Object) - Method in class org.refcodes.runtime.DumpBuilderImpl
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.
A C D E G H I K N O P R S T V W 
Skip navigation links

Copyright © 2018. All rights reserved.