Package convex.core.data

Class StringSlice

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<CVMChar>

convex.core.data.AString

convex.core.data.StringSlice

All Implemented Interfaces:

IValidated, IWriteable, Comparable<AString>

public class StringSlice
extends AString

AString subclass representing a subsequence of some Blob data

Field Summary

Fields inherited from class convex.core.data.AString

length

Fields inherited from class convex.core.data.ACell

cachedRef, EMPTY_ARRAY

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringSlice(AString source, long start, long length)

Method Summary

Modifier and Type	Method	Description
byte	byteAt(long i)	Gets a byte at the specified index.
int	charAt(long index)	Gets the Unicode character at position i, or -1 if not valid
int	compareTo(AString o)
static AString	create(StringTree source, long start, long len)
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first.
int	encodeRaw(byte[] bs, int pos)	Encode the data of this String.
int	encodeRawData(byte[] bs, int pos)	Encode the raw UTF-8 data of this String.
int	estimatedEncodingSize()	Estimate the encoded data size for this Cell.
int	getRefCount()	Gets the number of Refs contained within this Cell.
boolean	isCanonical()	Returns true if this Cell is in a canonical representation for message writing.
boolean	isCVMValue()	Returns true if this Cell represents a first class CVM Value.
AString	subSequence(long start, long end)
ABlob	toBlob()	Converts this String to a Blob byte representation.
AString	toCanonical()	Converts this Cell to its canonical version.
void	validateCell()	Validates the local structure and invariants of this cell.
protected void	writeToBuffer(ByteBuffer bb)

Methods inherited from class convex.core.data.AString

append, append, count, empty, get, getElementRef, getTag, getType, hashCode, intAt, print, toCVMString, toString

Methods inherited from class convex.core.data.ACountable

isEmpty, size

Methods inherited from class convex.core.data.ACell

announce, announce, attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createAnnounced, createEncoding, createPersisted, createPersisted, createRef, equals, equals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getRef, getRef, isCompletelyEncoded, isEmbedded, mark, mark, updateRefs, validate, write

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StringSlice

protected StringSlice(AString source,
 long start,
 long length)

Method Details

create

public static AString create(StringTree source,
 long start,
 long len)

charAt

public int charAt(long index)

Description copied from class: AString

Gets the Unicode character at position i, or -1 if not valid

Specified by:

charAt in class AString

Parameters:

index - Index into String (byte position)

Returns:

Unicode code point, or -1 if not a valid code point at this position

subSequence

public AString subSequence(long start,
 long end)

Specified by:

subSequence in class AString

validateCell

public void validateCell()
                  throws InvalidDataException

Description copied from class: ACell

Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the Cell is invalid

encode

public int encode(byte[] bs,
 int pos)

Description copied from class: ACell

Writes this Cell's encoding to a byte array, including a tag byte which will be written first. Cell must be canonical, or else an error may occur.

Specified by:

encode in interface IWriteable

Overrides:

encode in class AString

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

encodeRaw

public int encodeRaw(byte[] bs,
 int pos)

Description copied from class: AString

Encode the data of this String. Assumes tag already written

Specified by:

encodeRaw in class AString

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

encodeRawData

public int encodeRawData(byte[] bs,
 int pos)

Description copied from class: AString

Encode the raw UTF-8 data of this String. Assumes tag/length already written

Specified by:

encodeRawData in class AString

Parameters:

bs - Byte array to encode to

pos - Position in target array to write to

Returns:

End position in array after encoding

estimatedEncodingSize

public int estimatedEncodingSize()

Description copied from interface: IWriteable

Estimate the encoded data size for this Cell. Used for quickly sizing buffers. Implementations should try to return a size that is likely to contain the entire object when represented in binary format, including the tag byte.

Returns:

The estimated size for the binary representation of this object.

isCanonical

public boolean isCanonical()

Description copied from class: ACell

Returns true if this Cell is in a canonical representation for message writing. Non-canonical objects may be used on a temporary internal basis, they must always be converted to canonical representations for external use (e.g. Encoding).

Specified by:

isCanonical in class ACell

Returns:

true if the object is in canonical format, false otherwise

isCVMValue

public final boolean isCVMValue()

Description copied from class: ACell

Returns true if this Cell represents a first class CVM Value. Sub-structural cells that are not themselves first class values should return false, pretty much everything else should return true. Note: CVM values might not be in a canonical format, e.g. temporary data structures

Specified by:

isCVMValue in class ACell

Returns:

true if the object is a CVM Value, false otherwise

getRefCount

public int getRefCount()

Description copied from class: ACell

Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance and is defined by the Cell encoding rules. Contained Refs may be either external or embedded.

Specified by:

getRefCount in class ACell

Returns:

The number of Refs in this Cell

byteAt

public byte byteAt(long i)

Description copied from class: AString

Gets a byte at the specified index. Returns -1 (0xff) if outside String.

Specified by:

byteAt in class AString

Parameters:

i - Index into String (byte position)

Returns:

Raw byte value

toCanonical

public AString toCanonical()

Description copied from class: ACell

Converts this Cell to its canonical version. Returns this Cell if already canonical, may be O(n) in size of value otherwise.

Specified by:

toCanonical in class ACell

Returns:

Canonical version of Cell

toBlob

public ABlob toBlob()

Description copied from class: AString

Converts this String to a Blob byte representation. Must round trip all values.

Specified by:

toBlob in class AString

Returns:

Blob representation of UTF-8 String

compareTo

public int compareTo(AString o)

Specified by:

compareTo in interface Comparable<AString>

Specified by:

compareTo in class AString

writeToBuffer

protected void writeToBuffer(ByteBuffer bb)

Specified by:

writeToBuffer in class AString