Top Description Fields Constructors Methods
org.graalvm.polyglot.io

pack-priv final Class ByteArraySequence

extends Object
implements ByteSequence
Class Inheritance
All Implemented Interfaces
org.graalvm.polyglot.io.ByteSequence
Imports
java.util.Arrays

Implementation created in ByteSequence#create(byte[]).

Field Summary

Modifier and TypeField and Description
private final byte[]
private int
hash

Cache the hash code for the byte array sequences.

private final int
private final int

Constructor Summary

AccessConstructor and Description
pack-priv
ByteArraySequence(byte[] buffer, int start, int length)

Method Summary

Modifier and TypeMethod and Description
public byte
byteAt(int
the index of the byte value to be returned
index
)

Implements org.graalvm.polyglot.io.ByteSequence.byteAt.

Returns the byte value at the specified index.

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public int
length()

Implements org.graalvm.polyglot.io.ByteSequence.length.

Returns the length of this byte sequence.

public ByteSequence
subSequence(int
the start index, inclusive
startIndex
,
int
the end index, exclusive
endIndex
)

Overrides default org.graalvm.polyglot.io.ByteSequence.subSequence.

Returns a ByteSequence that is a subsequence of this sequence.

public byte[]
toByteArray()

Overrides default org.graalvm.polyglot.io.ByteSequence.toByteArray.

Returns a byte[] containing the bytes in this sequence in the same order as this sequence.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

bufferback to summary
private final byte[] buffer
hashback to summary
private int hash

Cache the hash code for the byte array sequences.

lengthback to summary
private final int length
startback to summary
private final int start

Constructor Detail

ByteArraySequenceback to summary
pack-priv ByteArraySequence(byte[] buffer, int start, int length)

Method Detail

byteAtback to summary
public byte byteAt(int index)

Implements org.graalvm.polyglot.io.ByteSequence.byteAt.

Doc from org.graalvm.polyglot.io.ByteSequence.byteAt.

Returns the byte value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

Parameters
index:int

the index of the byte value to be returned

Returns:byte

the specified byte value

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
lengthback to summary
public int length()

Implements org.graalvm.polyglot.io.ByteSequence.length.

Doc from org.graalvm.polyglot.io.ByteSequence.length.

Returns the length of this byte sequence.

Returns:int

the number of bytes in this sequence

subSequenceback to summary
public ByteSequence subSequence(int startIndex, int endIndex)

Overrides default org.graalvm.polyglot.io.ByteSequence.subSequence.

Doc from org.graalvm.polyglot.io.ByteSequence.subSequence.

Returns a ByteSequence that is a subsequence of this sequence. The subsequence starts with the byte value at the specified index and ends with the byte value at index end - 1. The length (in bytes) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters
startIndex:int

the start index, inclusive

endIndex:int

the end index, exclusive

Returns:ByteSequence

the specified subsequence

toByteArrayback to summary
public byte[] toByteArray()

Overrides default org.graalvm.polyglot.io.ByteSequence.toByteArray.

Doc from org.graalvm.polyglot.io.ByteSequence.toByteArray.

Returns a byte[] containing the bytes in this sequence in the same order as this sequence. The length of the byte array will be the length of this sequence. Creates a new byte array with every invocation.