Package com.yahoo.data.access.simple

Class Value

java.lang.Object

com.yahoo.data.access.simple.Value

All Implemented Interfaces:

Inspectable, Inspector

Direct Known Subclasses:

MatchFeatureData.HitValue, Value.ArrayValue, Value.BoolValue, Value.DataValue, Value.DoubleValue, Value.EmptyValue, Value.LongValue, Value.ObjectValue, Value.StringValue

public class Value
extends Object
implements Inspector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Value.ArrayValue
static class	Value.BoolValue
static class	Value.DataValue
static class	Value.DoubleValue
static class	Value.EmptyValue
static class	Value.LongValue
static class	Value.ObjectValue
static class	Value.StringValue

Constructor Summary

Constructors

Constructor	Description
Value()

Method Summary

Modifier and Type	Method	Description
boolean	asBool()	Access the inspector's value if it's a BOOLEAN; otherwise throws exception
boolean	asBool(boolean defaultValue)	Get the inspector's value (or the supplied default), never throws
byte[]	asData()	Access the inspector's value if it's DATA; otherwise throws exception
byte[]	asData(byte[] defaultValue)	Get the inspector's value (or the supplied default), never throws
double	asDouble()	Access the inspector's value if it's a DOUBLE (or LONG); otherwise throws exception
double	asDouble(double defaultValue)	Get the inspector's value (or the supplied default), never throws
long	asLong()	Access the inspector's value if it's a LONG (or DOUBLE); otherwise throws exception
long	asLong(long defaultValue)	Get the inspector's value (or the supplied default), never throws
String	asString()	Access the inspector's value if it's a STRING; otherwise throws exception
String	asString(String defaultValue)	Get the inspector's value (or the supplied default), never throws
byte[]	asUtf8()	Access the inspector's value (in utf-8 representation) if it's a STRING; otherwise throws exception
byte[]	asUtf8(byte[] defaultValue)	Get the inspector's value (or the supplied default), never throws
static Inspector	empty()
Iterable<Inspector>	entries()	Convert an array to an iterable list.
Inspector	entry(int idx)	Access an array entry.
int	entryCount()	Get the number of entries in an ARRAY (always returns 0 for non-arrays)
Inspector	field(String name)	Access an field in an object.
int	fieldCount()	Get the number of fields in an OBJECT (always returns 0 for non-objects)
Iterable<Map.Entry<String,Inspector>>	fields()	Convert an object to an iterable list of (name, value) pairs.
Inspector	inspect()	Returns an Inspector exposing this object's structured data.
static Inspector	invalid()
String	toJson()
String	toString()
void	traverse(ArrayTraverser at)	Traverse an array value, performing callbacks for each entry.
void	traverse(ObjectTraverser ot)	Traverse an object value, performing callbacks for each field.
Type	type()	Get the type of an inspector
boolean	valid()	Check if the inspector is valid.
StringBuilder	writeJson(StringBuilder target)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Value

public Value()

Method Details

empty

public static Inspector empty()

invalid

public static Inspector invalid()

inspect

public Inspector inspect()

Description copied from interface: Inspectable

Returns an Inspector exposing this object's structured data.

Specified by:

inspect in interface Inspectable

valid

public boolean valid()

Description copied from interface: Inspector

Check if the inspector is valid. If you try to access a field or array entry that does not exist, you will get an invalid Inspector returned.

Specified by:

valid in interface Inspector

type

public Type type()

Description copied from interface: Inspector

Get the type of an inspector

Specified by:

type in interface Inspector

entryCount

public int entryCount()

Description copied from interface: Inspector

Get the number of entries in an ARRAY (always returns 0 for non-arrays)

Specified by:

entryCount in interface Inspector

fieldCount

public int fieldCount()

Description copied from interface: Inspector

Get the number of fields in an OBJECT (always returns 0 for non-objects)

Specified by:

fieldCount in interface Inspector

asBool

public boolean asBool()

Description copied from interface: Inspector

Access the inspector's value if it's a BOOLEAN; otherwise throws exception

Specified by:

asBool in interface Inspector

asLong

public long asLong()

Description copied from interface: Inspector

Access the inspector's value if it's a LONG (or DOUBLE); otherwise throws exception

Specified by:

asLong in interface Inspector

asDouble

public double asDouble()

Description copied from interface: Inspector

Access the inspector's value if it's a DOUBLE (or LONG); otherwise throws exception

Specified by:

asDouble in interface Inspector

asString

public String asString()

Description copied from interface: Inspector

Access the inspector's value if it's a STRING; otherwise throws exception

Specified by:

asString in interface Inspector

asUtf8

public byte[] asUtf8()

Description copied from interface: Inspector

Access the inspector's value (in utf-8 representation) if it's a STRING; otherwise throws exception

Specified by:

asUtf8 in interface Inspector

asData

public byte[] asData()

Description copied from interface: Inspector

Access the inspector's value if it's DATA; otherwise throws exception

Specified by:

asData in interface Inspector

asBool

public boolean asBool(boolean defaultValue)

Description copied from interface: Inspector

Get the inspector's value (or the supplied default), never throws

Specified by:

asBool in interface Inspector

asLong

public long asLong(long defaultValue)

Description copied from interface: Inspector

Get the inspector's value (or the supplied default), never throws

Specified by:

asLong in interface Inspector

asDouble

public double asDouble(double defaultValue)

Description copied from interface: Inspector

Get the inspector's value (or the supplied default), never throws

Specified by:

asDouble in interface Inspector

asString

public String asString(String defaultValue)

Description copied from interface: Inspector

Get the inspector's value (or the supplied default), never throws

Specified by:

asString in interface Inspector

asUtf8

public byte[] asUtf8(byte[] defaultValue)

Description copied from interface: Inspector

Get the inspector's value (or the supplied default), never throws

Specified by:

asUtf8 in interface Inspector

asData

public byte[] asData(byte[] defaultValue)

Description copied from interface: Inspector

Get the inspector's value (or the supplied default), never throws

Specified by:

asData in interface Inspector

traverse

public void traverse(ArrayTraverser at)

Description copied from interface: Inspector

Traverse an array value, performing callbacks for each entry. If the current Inspector is connected to an array value, perform callbacks to the given traverser for each entry contained in the array. Otherwise a no-op.

Specified by:

traverse in interface Inspector

Parameters:

at - traverser callback object

traverse

public void traverse(ObjectTraverser ot)

Description copied from interface: Inspector

Traverse an object value, performing callbacks for each field. If the current Inspector is connected to an object value, perform callbacks to the given traverser for each field contained in the object. Otherwise a no-op.

Specified by:

traverse in interface Inspector

Parameters:

ot - traverser callback object

entry

public Inspector entry(int idx)

Description copied from interface: Inspector

Access an array entry. If the current Inspector doesn't connect to an array value, or the given array index is out of bounds, the returned Inspector will be invalid.

Specified by:

entry in interface Inspector

Parameters:

idx - array index

Returns:

a new Inspector for the entry value

field

public Inspector field(String name)

Description copied from interface: Inspector

Access an field in an object. If the current Inspector doesn't connect to an object value, or the object value does not contain a field with the given symbol name, the returned Inspector will be invalid.

Specified by:

field in interface Inspector

Parameters:

name - symbol name

Returns:

a new Inspector for the field value

entries

public Iterable<Inspector> entries()

Description copied from interface: Inspector

Convert an array to an iterable list. Other types will just return an empty list.

Specified by:

entries in interface Inspector

fields

public Iterable<Map.Entry<String,Inspector>> fields()

Description copied from interface: Inspector

Convert an object to an iterable list of (name, value) pairs. Other types will just return an empty list.

Specified by:

fields in interface Inspector

writeJson

public StringBuilder writeJson(StringBuilder target)

toJson

public String toJson()

toString

public String toString()

Overrides:

toString in class Object