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

A C E G H I K L N O P R S T V

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
Attribute - Interface in org.refcodes.runtime: Interface describing a bean's attribute.
AttributeImpl(String, Object) - Constructor for class org.refcodes.runtime.ReflectionUtility.AttributeImpl: Constructs a key-to-value property.

C

CommandLineInterpreter - Enum in org.refcodes.runtime: Enumeration with the (supported) operating systems.

E

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

geCallerType() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns the type of the (Class) belonging to the direct caller of this method.
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(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.
getCommandLineInterpreter() - Static method in class org.refcodes.runtime.SystemUtility: 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.
getComputerName() - Static method in class org.refcodes.runtime.SystemUtility: Determines the computer's name.
getConsoleHeight() - Static method in class org.refcodes.runtime.SystemUtility: Determines the height in characters of the system's console in use.
getConsoleWidth() - Static method in class org.refcodes.runtime.SystemUtility: Determines the width in characters of the system's console in use.
getCorrelationId() - Method in class org.refcodes.runtime.impls.ProcessCorrelationImpl
getCorrelationId() - Method in interface org.refcodes.runtime.ProcessCorrelation: Retrieves the correlation ID assigned to the current Thread.
getInstance() - Method in class org.refcodes.runtime.impls.ProcessCorrelationSingleton
getLineBreak() - Static method in class org.refcodes.runtime.SystemUtility: Determines the operating system as of SystemUtility.getOperatingSystem() 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.
getOperatingSystem() - Static method in class org.refcodes.runtime.SystemUtility: Determines the operating system your application is currently running on.
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.
getTempDir() - Static method in class org.refcodes.runtime.SystemUtility: Returns the operating saystem's temp folder.
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

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

isAnsiSupported() - Static method in class org.refcodes.runtime.SystemUtility: Determines whether ANSI escape sequences are supported by the console.

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.

L

loadProperties(String) - Static method in class org.refcodes.runtime.RuntimeUtility: Loads a properties file from the first folder containing such a file as of the specification for the method RuntimeUtility.toAppConfigDirs().

N

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: Constants: The const package contains enumerations and static final interface variables (constants) being the invariants as used by this artifact.
org.refcodes.runtime.impls - package org.refcodes.runtime.impls: Implementations: The impls package contains implementations of the types defined by this artifact.

P

ProcessCorrelation - Interface in org.refcodes.runtime: The ProcessCorrelation assigns a 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.
ProcessCorrelationImpl - Class in org.refcodes.runtime.impls
ProcessCorrelationImpl() - Constructor for class org.refcodes.runtime.impls.ProcessCorrelationImpl
ProcessCorrelationSingleton - Class in org.refcodes.runtime.impls

R

ReflectionUtility - Class in org.refcodes.runtime
ReflectionUtility.AttributeImpl - Class in org.refcodes.runtime: Class describing a beans's attribute.
ReflectionUtility.NonExistingValueClass - Class in org.refcodes.runtime: This class indicates a non existing value in the name-to-value mapping
RuntimePropertiesImpl - Class in org.refcodes.runtime.impls: The RuntimePropertiesImpl load the first properties file found (with "key=value" entries) in one of several default locations determined by the RuntimeUtility.toAppConfigDirs() method.
RuntimePropertiesImpl(String) - Constructor for class org.refcodes.runtime.impls.RuntimePropertiesImpl: Loads a properties file from the first folder containing such a file as of the specification for the method RuntimeUtility.toAppConfigDirs().
RuntimeUtility - Class in org.refcodes.runtime: Utility for acquiring runtime information on software systems, classes or objects.

S

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.
setCorrelationId(String) - Method in class org.refcodes.runtime.impls.ProcessCorrelationImpl
setCorrelationId(String) - Method in interface org.refcodes.runtime.ProcessCorrelation: Assigns the given correlation ID to the current Thread.
SystemUtility - Class in org.refcodes.runtime: Utility for acquiring system information on the machine this process is running in.

T

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.
toAppBaseDir() - Static method in class org.refcodes.runtime.RuntimeUtility: Generates the base path relative to the given class location.
toAppConfigDirs() - Static method in class org.refcodes.runtime.RuntimeUtility: Returns a list of (existing) folders which are candidates for external resources.
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.
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).
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.
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.
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.

V

valueOf(String) - Static method in enum org.refcodes.runtime.CommandLineInterpreter: 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.
values() - Static method in enum org.refcodes.runtime.CommandLineInterpreter: 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.

A C E G H I K L N O P R S T V