Interface ArrayReference

All Superinterfaces:: Mirror, ObjectReference, Value

public interface ArrayReference extends ObjectReference

Provides access to an array object and its components in the target VM. Each array component is mirrored by a Value object. The array components, in aggregate, are placed in List objects instead of arrays for consistency with the rest of the API and for interoperability with other APIs.

Since:: 1.3

Field Summary

Fields declared in interface ObjectReference

INVOKE_NONVIRTUAL, INVOKE_SINGLE_THREADED

Modifier and Type	Field	Description
`static final int`	`INVOKE_NONVIRTUAL`	Perform non-virtual method invocation
`static final int`	`INVOKE_SINGLE_THREADED`	Perform method invocation with only the invoking thread resumed

Method Summary

Modifier and Type	Method	Description
`Value`	`getValue(int index)`	Returns an array component value.
`List<Value>`	`getValues()`	Returns all of the components in this array.
`List<Value>`	`getValues(int index, int length)`	Returns a range of array components.
`int`	`length()`	Returns the number of components in this array.
`void`	`setValue(int index, Value value)`	Replaces an array component with another value.
`void`	`setValues(int index, List<? extends Value> values, int srcIndex, int length)`	Replaces a range of array components with other values.
`void`	`setValues(List<? extends Value> values)`	Replaces all array components with other values.

Methods declared in interface Mirror

toString, virtualMachine

Modifier and Type	Method	Description
`String`	`toString()`	Returns a String describing this mirror
`VirtualMachine`	`virtualMachine()`	Gets the VirtualMachine to which this Mirror belongs.

Methods declared in interface ObjectReference

disableCollection, enableCollection, entryCount, equals, getValue, getValues, hashCode, invokeMethod, isCollected, owningThread, referenceType, referringObjects, setValue, uniqueID, waitingThreads

Modifier and Type	Method	Description
`void`	`disableCollection()`	Prevents garbage collection for this object.
`void`	`enableCollection()`	Permits garbage collection for this object.
`int`	`entryCount()`	Returns the number of times this object's monitor has been entered by the current owning thread if the owning thread is platform thread; Returns 0 if not owned by a platform thread.
`boolean`	`equals(Object obj)`	Compares the specified Object with this ObjectReference for equality.
`Value`	`getValue(Field sig)`	Gets the value of a given instance or static field in this object.
`Map<Field,Value>`	`getValues(List<? extends Field> fields)`	Gets the value of multiple instance and/or static fields in this object.
`int`	`hashCode()`	Returns the hash code value for this ObjectReference.
`Value`	`invokeMethod(ThreadReference thread, Method method, List<? extends Value> arguments, int options)`	Invokes the specified `Method` on this object in the target VM.
`boolean`	`isCollected()`	Determines if this object has been garbage collected in the target VM.
`ThreadReference`	`owningThread()`	Returns a `ThreadReference` for the platform thread, if any, which currently owns this object's monitor.
`ReferenceType`	`referenceType()`	Gets the `ReferenceType` that mirrors the type of this object.
`List<ObjectReference>`	`referringObjects(long maxReferrers)`	Returns objects that directly reference this object.
`void`	`setValue(Field field, Value value)`	Sets the value of a given instance or static field in this object.
`long`	`uniqueID()`	Returns a unique identifier for this ObjectReference.
`List<ThreadReference>`	`waitingThreads()`	Returns a List containing a `ThreadReference` for each platform thread currently waiting for this object's monitor.

Methods declared in interface Value

type

Modifier and Type	Method	Description
`Type`	`type()`	Returns the run-time type of this value.

Method Details

length

int length()

Returns the number of components in this array.

Returns:: the integer count of components in this array.

getValue

Value getValue(int index)

Returns an array component value.

Parameters:

index - the index of the component to retrieve

Returns:

the Value at the given index.

Throws:

IndexOutOfBoundsException - if index is outside the range of this array, that is, if either of the following are true:

   index < 0
   index >= length()

getValues

List<Value> getValues()

Returns all of the components in this array.

Returns:: a list of Value objects, one for each array component ordered by array index. For zero length arrays, an empty list is returned.

getValues

List<Value> getValues(int index, int length)

Returns a range of array components.

Parameters:

index - the index of the first component to retrieve

length - the number of components to retrieve, or -1 to retrieve all components to the end of this array.

Returns:

a list of Value objects, one for each requested array component ordered by array index. When there are no elements in the specified range (e.g. length is zero) an empty list is returned

Throws:

IndexOutOfBoundsException - if the range specified with index and length is not within the range of the array, that is, if either of the following are true:

   index < 0
   index > length()

or if length != -1 and either of the following are true:

   length < 0
   index + length >  length()

setValue

void setValue(int index, Value value) throws InvalidTypeException, ClassNotLoadedException

Replaces an array component with another value.

Object values must be assignment compatible with the component type (This implies that the component type must be loaded through the declaring class's class loader). Primitive values must be either assignment compatible with the component type or must be convertible to the component type without loss of information. See JLS section 5.2 for more information on assignment compatibility.

Parameters:

index - the index of the component to set

value - the new value

Throws:

IndexOutOfBoundsException - if index is outside the range of this array, that is, if either of the following are true:

   index < 0
   index >= length()

InvalidTypeException - if the type of value is not compatible with the declared type of array components.

ClassNotLoadedException - if the array component type has not yet been loaded through the appropriate class loader.

VMCannotBeModifiedException - if the VirtualMachine is read-only - see VirtualMachine.canBeModified().

See Also:

setValues

void setValues(List<? extends Value> values) throws InvalidTypeException, ClassNotLoadedException

Replaces all array components with other values. If the given list is larger in size than the array, the values at the end of the list are ignored.

Object values must be assignment compatible with the element type (This implies that the component type must be loaded through the enclosing class's class loader). Primitive values must be either assignment compatible with the component type or must be convertible to the component type without loss of information. See JLS section 5.2 for more information on assignment compatibility.

Parameters:

values - a list of Value objects to be placed in this array. If values.size() is less that the length of the array, the first values.size() elements are set.

Throws:

InvalidTypeException - if any of the new values is not compatible with the declared type of array components.

ClassNotLoadedException - if the array component type has not yet been loaded through the appropriate class loader.

VMCannotBeModifiedException - if the VirtualMachine is read-only - see VirtualMachine.canBeModified().

See Also:

setValues

void setValues(int index, List<? extends Value> values, int srcIndex, int length) throws InvalidTypeException, ClassNotLoadedException

Replaces a range of array components with other values.

Object values must be assignment compatible with the component type (This implies that the component type must be loaded through the enclosing class's class loader). Primitive values must be either assignment compatible with the component type or must be convertible to the component type without loss of information. See JLS section 5.2 for more information on assignment compatibility.

Parameters:

index - the index of the first component to set.

values - a list of Value objects to be placed in this array.

srcIndex - the index of the first source value to use.

length - the number of components to set, or -1 to set all components to the end of this array or the end of values (whichever comes first).

Throws:

InvalidTypeException - if any element of values is not compatible with the declared type of array components.

IndexOutOfBoundsException - if the array range specified with index and length is not within the range of the array, or if the source range specified with srcIndex and length is not within values, that is, if any of the following are true:

   index < 0
   index > length()
   srcIndex < 0
   srcIndex > values.size()

or if length != -1 and any of the following are true:

   length < 0
   index + length > length()
   srcIndex + length > values.size()

VMCannotBeModifiedException - if the VirtualMachine is read-only - see VirtualMachine.canBeModified().

ClassNotLoadedException

See Also:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.