net.openhft.chronicle.testframework.mappedfiles

Enum MappedFileUtil

java.lang.Object

java.lang.Enum<MappedFileUtil>

net.openhft.chronicle.testframework.mappedfiles.MappedFileUtil

All Implemented Interfaces:

Serializable, Comparable<MappedFileUtil>

public enum MappedFileUtil
extends Enum<MappedFileUtil>

Utility class for working with mapped files, specifically dealing with parsing the "/proc/self/maps" file on Linux systems. This provides information about virtual memory mappings.

NOTE: This utility is designed to work on Linux or Linux-like environments.

Method Summary

Modifier and Type	Method and Description
static String	getAddress(Matcher matcher) Gets the memory address range from the provided Matcher object.
static Set<String>	getAllMappedFiles() Get the distinct files that are currently mapped to the current process
static @Nullable String	getPath(Matcher matcher) Gets the path (if any) from the provided Matcher object.
static Matcher	parseMapsLine(String line) Parses the provided line using the pattern defined for parsing lines from "/proc/self/maps".
static MappedFileUtil	valueOf(String name) Returns the enum constant of this type with the specified name.
static MappedFileUtil[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static MappedFileUtil[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MappedFileUtil c : MappedFileUtil.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MappedFileUtil valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getAllMappedFiles

public static Set<String> getAllMappedFiles()

Get the distinct files that are currently mapped to the current process

NOTE: this is only likely to work on linux or linux-like environments

Returns:

A set of the distinct files listed in /proc/self/maps

Throws:

UnsupportedOperationException - if /proc/self/maps does not exist or can't be read

parseMapsLine

public static Matcher parseMapsLine(String line)

Parses the provided line using the pattern defined for parsing lines from "/proc/self/maps".

Parameters:

line - The line to be parsed

Returns:

A Matcher object after matching the pattern

getPath

@Nullable
public static @Nullable String getPath(Matcher matcher)

Gets the path (if any) from the provided Matcher object.

Parameters:

matcher - Matcher object containing the parsed line

Returns:

The path if available, null otherwise

getAddress

public static String getAddress(Matcher matcher)

Gets the memory address range from the provided Matcher object.

Parameters:

matcher - Matcher object containing the parsed line

Returns:

The address range as a string