com.marklogic.client.eval

Interface EvalResult

public interface EvalResult

Represents the content and metadata of a result from a call to eval. Also includes some convenience methods for deserializing the result as a String, Number, Boolean, AbstractReadHandle, or an object of any Class which is registered by a ContentHandle.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EvalResult.Type Convenience enum useful for strongly-typed comparison to ensure the result is of the type expected.

Method Summary

Modifier and Type	Method and Description
<H extends AbstractReadHandle> H	get(H handle) Use a handle to retrieve the contents of this result.
<T> T	getAs(Class<T> clazz) An io shortcut method to get the contents as an object of the specified type, which must be a registered type.
Boolean	getBoolean() This result parsed to a Boolean.
Format	getFormat() The format of this result from the Content-Type header provided by the REST API eval endpoint.
Number	getNumber() This result parsed to a Number.
String	getString() This result directly as a string.
EvalResult.Type	getType() The EvalResult.Type of this result from the X-Primitive header provided by the REST API eval endpoint.

Method Detail

getType

EvalResult.Type getType()

The EvalResult.Type of this result from the X-Primitive header provided by the REST API eval endpoint.

Returns:

the type of this result

See Also:

REST GUIDE -> eval endpoint

getFormat

Format getFormat()

The format of this result from the Content-Type header provided by the REST API eval endpoint.

Returns:

the format of this result

See Also:

REST GUIDE -> eval endpoint

get

<H extends AbstractReadHandle> H get(H handle)

Use a handle to retrieve the contents of this result.

Type Parameters:

H - the type of AbstractReadHandle to return

Parameters:

handle - the handle to populate with the contents of this result

Returns:

the handle populated with the contents of this result

getAs

<T> T getAs(Class<T> clazz)

An io shortcut method to get the contents as an object of the specified type, which must be a registered type.

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

clazz - the Class (type). This type must be registered by an io handle.

Returns:

an instance of the requested type populated with the contents of this result

getString

String getString()

This result directly as a string.

Returns:

this result as a string

getNumber

Number getNumber()

This result parsed to a Number.

Returns:

this result as a number

getBoolean

Boolean getBoolean()

This result parsed to a Boolean.

Returns:

a boolean as generated by new Boolean(getString())