com.jrockit.memleak
Interface ITruncatable<T>

Type Parameters:

T - the element type

All Superinterfaces:

IResult<T[]>

All Known Implementing Classes:

AbstractMemLeak.DelayedTruncatable, KnownTruncatable, MemLeakR26.LargestArrayR26, MemLeakR28.GetInstanceRelationshipsR28, MemLeakR28.LargestArrayR28

public interface ITruncatable<T>
extends IResult<T[]>

Array result wrapper in many ways similar to Future.

Author:

mpersson

Nested Class Summary

static class

ITruncatable.Reason Standard reasons for truncation.

Method Summary

T[]	get() The actual result array, possibly truncated.
java.lang.Exception	getException() If an exception was thrown, returns that Exception.
ITruncatable.Reason	getTruncationReason() If the result was truncated, returns a ITruncatable.Reason for the truncation.
boolean	isTruncated()

Methods inherited from interface com.jrockit.memleak.IResult

getChangeTime, isDone, isDone

Method Detail

get

T[] get()

The actual result array, possibly truncated. This method will never return null.

Specified by:

get in interface IResult<T[]>

Returns:

an array, possibly empty.

isTruncated

boolean isTruncated()

Returns:

true iff this array was truncated

getTruncationReason

ITruncatable.Reason getTruncationReason()

If the result was truncated, returns a ITruncatable.Reason for the truncation. Otherwise, null is returned. Note that if getException() returns non-null, this method will also return non-null, most probably ITruncatable.Reason.EXCEPTION.

Returns:

the reason for truncation, or null if the result wasn't truncated.

getException

java.lang.Exception getException()

If an exception was thrown, returns that Exception. Otherwise, null is returned.

Returns:

the thrown exception, if any, null otherwise.