net.openhft.chronicle.tools

Enum ChronicleTools

java.lang.Object

java.lang.Enum<ChronicleTools>

net.openhft.chronicle.tools.ChronicleTools

All Implemented Interfaces:

Serializable, Comparable<ChronicleTools>

public enum ChronicleTools
extends Enum<ChronicleTools>

Author:

peter.lawrey

Method Summary

Methods

Modifier and Type	Method and Description
static String	asString(ByteBuffer bb)
static String	asString(ExcerptCommon excerpt) Take a text copy of the contents of the Excerpt without changing it's position.
static String	asString(ExcerptCommon excerpt, long position) Take a text copy of the contents of the Excerpt without changing it's position.
static String	asString(ExcerptCommon excerpt, long position, long length) Take a text copy of the contents of the Excerpt without changing it's position.
static void	deleteDirOnExit(String dirPath)
static void	deleteOnExit(String basePath) Delete a chronicle now and on exit, for testing
static ChronicleTools	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChronicleTools[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static void	warmup()

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static ChronicleTools[] 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 (ChronicleTools c : ChronicleTools.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChronicleTools 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

deleteOnExit

public static void deleteOnExit(String basePath)

Delete a chronicle now and on exit, for testing

Parameters:

basePath - of the chronicle

deleteDirOnExit

public static void deleteDirOnExit(String dirPath)

asString

@NotNull
public static String asString(@NotNull
                      ByteBuffer bb)

asString

@NotNull
public static String asString(@NotNull
                      ExcerptCommon excerpt)

Take a text copy of the contents of the Excerpt without changing it's position. Can be called in the debugger.

Parameters:

excerpt - to get text from

Returns:

256 bytes as text with `.` replacing special bytes.

asString

@NotNull
public static String asString(@NotNull
                      ExcerptCommon excerpt,
                      long position)

Take a text copy of the contents of the Excerpt without changing it's position. Can be called in the debugger.

Parameters:

excerpt - to get text from

position - the position to get text from

Returns:

up to 1024 bytes as text with `.` replacing special bytes.

asString

@NotNull
public static String asString(@NotNull
                      ExcerptCommon excerpt,
                      long position,
                      long length)

Take a text copy of the contents of the Excerpt without changing it's position. Can be called in the debugger.

Parameters:

excerpt - to get text from

position - the position to get text from

length - the maximum length

Returns:

length bytes as text with `.` replacing special bytes.

warmup

public static void warmup()