Package io.deephaven.base.string.cache

Class AbstractCompressedString<TYPE extends AbstractCompressedString>

java.lang.Object

io.deephaven.base.string.cache.AbstractCompressedString<TYPE>

All Implemented Interfaces:

StringAlike<TYPE>, StringCompatible, Serializable, CharSequence, Comparable<CharSequence>

Direct Known Subclasses:

CompressedString, MappedCompressedString

public abstract class AbstractCompressedString<TYPE extends AbstractCompressedString>
extends Object
implements StringAlike<TYPE>

Base class for immutable byte[]-backed String replacements.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
final char	charAt(int index)
final int	codePointAt(int index)
final int	codePointBefore(int index)
final int	codePointCount(int beginIndex, int endIndex)
final int	compareTo(@NotNull CharSequence that)	Implementations MUST compare StringCompatibles and Strings char-by-char.
final int	compareToIgnoreCase(@NotNull CharSequence that)
final TYPE	concat(String other)
final TYPE	concat(TYPE other)
final boolean	contains(CharSequence cs)
final boolean	contentEquals(@NotNull CharSequence cs)
protected abstract TYPE	convertValue(byte[] data, int offset, int length)	Convert a byte array to this type, assuming ISO-8859-1
protected abstract TYPE	convertValue(String string)	Convert a String to this type.
final boolean	endsWith(@NotNull CharSequence suffix)
final boolean	equals(Object that)
final boolean	equalsIgnoreCase(@NotNull CharSequence that)
final byte[]	getBytes()
final void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
final byte[]	getData()	Note: This is an API for trusted code to use.
final int	hashCode()	Implementations MUST match the current implementation of String.hashCode().
final int	indexOf(int ch)
final int	indexOf(int ch, int fromIndex)
final int	indexOf(CharSequence cs)
final int	indexOf(CharSequence cs, int fromIndex)
final TYPE	intern()
final boolean	isEmpty()
final int	lastIndexOf(int ch)
final int	lastIndexOf(int ch, int fromIndex)
final int	lastIndexOf(CharSequence cs)
final int	lastIndexOf(CharSequence cs, int fromIndex)
final int	length()
final boolean	matches(CharSequence regex)
final boolean	regionMatches(boolean ignoreCase, int offset, CharSequence that, int thatOffset, int length)
final TYPE	replace(char oldChar, char newChar)
final TYPE	replace(CharSequence target, CharSequence replacement)
final TYPE	replaceAll(CharSequence regex, CharSequence replacement)
final TYPE	replaceFirst(CharSequence regex, CharSequence replacement)
final TYPE[]	split(CharSequence regex)
final TYPE[]	split(CharSequence regex, int limit)
final boolean	startsWith(@NotNull CharSequence prefix)
final boolean	startsWith(@NotNull CharSequence prefix, int offset)
final CharSequence	subSequence(int start, int end)
final TYPE	substring(int beginIndex)
final TYPE	substring(int beginIndex, int endIndex)
final char[]	toCharArray()
final TYPE	toLowerCase()
final TYPE	toLowerCase(Locale locale)
final @NotNull String	toString()	Convert this StringCompatible into a String.
final TYPE	toUpperCase()
final TYPE	toUpperCase(Locale locale)
final TYPE	trim()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface io.deephaven.base.string.cache.StringCompatible

toCompressedString, toMappedCompressedString

Method Details

convertValue

protected abstract TYPE convertValue(String string)

Convert a String to this type.

Parameters:

string - The String to convert

Returns:

A new TYPE with the same contents as String, assuming ISO-8859-1 encoding

convertValue

protected abstract TYPE convertValue(byte[] data,
 int offset,
 int length)

Convert a byte array to this type, assuming ISO-8859-1

Parameters:

data - The data to convert

offset - The starting index from data to convert

length - The length to convert

Returns:

A new TYPE with the same contents as the specified region of data, assuming ISO-8859-1 encoding

getData

public final byte[] getData()

Note: This is an API for trusted code to use. The data array must not be modified.

Returns:

The internal data array for this instance.

length

public final int length()

Specified by:

length in interface CharSequence

charAt

public final char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public final CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

toString

@NotNull
public final @NotNull String toString()

Description copied from interface: StringCompatible

Convert this StringCompatible into a String. Implementations should not cache result Strings, in order to avoid inadvertently allowing promotion of short-lived objects under generational garbage collection.

Specified by:

toString in interface CharSequence

Specified by:

toString in interface StringCompatible

Overrides:

toString in class Object

Returns:

A newly constructed String representing the same sequence of characters as this StringCompatible.

compareTo

public final int compareTo(@NotNull
 @NotNull CharSequence that)

Description copied from interface: StringCompatible

Implementations MUST compare StringCompatibles and Strings char-by-char.

Specified by:

compareTo in interface Comparable<TYPE extends AbstractCompressedString>

Specified by:

compareTo in interface StringCompatible

Returns:

0, <0, or >0 if that compares equal-to, less-than, or greater-than this.

hashCode

public final int hashCode()

Description copied from interface: StringCompatible

Implementations MUST match the current implementation of String.hashCode().

Specified by:

hashCode in interface StringCompatible

Overrides:

hashCode in class Object

Returns:

A hashcode value for this StringCompatible that matches the value a String of the same chars.

equals

public final boolean equals(Object that)

Specified by:

equals in interface StringCompatible

Overrides:

equals in class Object

Returns:

true iff that is a StringCompatible of the same class with identical members.

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface CharSequence

Specified by:

isEmpty in interface StringAlike<TYPE extends AbstractCompressedString>

codePointAt

public final int codePointAt(int index)

Specified by:

codePointAt in interface StringAlike<TYPE extends AbstractCompressedString>

codePointBefore

public final int codePointBefore(int index)

Specified by:

codePointBefore in interface StringAlike<TYPE extends AbstractCompressedString>

codePointCount

public final int codePointCount(int beginIndex,
 int endIndex)

Specified by:

codePointCount in interface StringAlike<TYPE extends AbstractCompressedString>

getChars

public final void getChars(int srcBegin,
 int srcEnd,
 char[] dst,
 int dstBegin)

Specified by:

getChars in interface StringAlike<TYPE extends AbstractCompressedString>

getBytes

public final byte[] getBytes()

Specified by:

getBytes in interface StringAlike<TYPE extends AbstractCompressedString>

contentEquals

public final boolean contentEquals(@NotNull
 @NotNull CharSequence cs)

Specified by:

contentEquals in interface StringAlike<TYPE extends AbstractCompressedString>

equalsIgnoreCase

public final boolean equalsIgnoreCase(@NotNull
 @NotNull CharSequence that)

Specified by:

equalsIgnoreCase in interface StringAlike<TYPE extends AbstractCompressedString>

compareToIgnoreCase

public final int compareToIgnoreCase(@NotNull
 @NotNull CharSequence that)

Specified by:

compareToIgnoreCase in interface StringAlike<TYPE extends AbstractCompressedString>

regionMatches

public final boolean regionMatches(boolean ignoreCase,
 int offset,
 CharSequence that,
 int thatOffset,
 int length)

Specified by:

regionMatches in interface StringAlike<TYPE extends AbstractCompressedString>

startsWith

public final boolean startsWith(@NotNull
 @NotNull CharSequence prefix,
 int offset)

Specified by:

startsWith in interface StringAlike<TYPE extends AbstractCompressedString>

startsWith

public final boolean startsWith(@NotNull
 @NotNull CharSequence prefix)

Specified by:

startsWith in interface StringAlike<TYPE extends AbstractCompressedString>

endsWith

public final boolean endsWith(@NotNull
 @NotNull CharSequence suffix)

Specified by:

endsWith in interface StringAlike<TYPE extends AbstractCompressedString>

indexOf

public final int indexOf(int ch,
 int fromIndex)

Specified by:

indexOf in interface StringAlike<TYPE extends AbstractCompressedString>

indexOf

public final int indexOf(int ch)

Specified by:

indexOf in interface StringAlike<TYPE extends AbstractCompressedString>

lastIndexOf

public final int lastIndexOf(int ch,
 int fromIndex)

Specified by:

lastIndexOf in interface StringAlike<TYPE extends AbstractCompressedString>

lastIndexOf

public final int lastIndexOf(int ch)

Specified by:

lastIndexOf in interface StringAlike<TYPE extends AbstractCompressedString>

substring

public final TYPE substring(int beginIndex,
 int endIndex)

Specified by:

substring in interface StringAlike<TYPE extends AbstractCompressedString>

substring

public final TYPE substring(int beginIndex)

Specified by:

substring in interface StringAlike<TYPE extends AbstractCompressedString>

concat

public final TYPE concat(String other)

Specified by:

concat in interface StringAlike<TYPE extends AbstractCompressedString>

concat

public final TYPE concat(TYPE other)

Specified by:

concat in interface StringAlike<TYPE extends AbstractCompressedString>

matches

public final boolean matches(CharSequence regex)

Specified by:

matches in interface StringAlike<TYPE extends AbstractCompressedString>

trim

public final TYPE trim()

Specified by:

trim in interface StringAlike<TYPE extends AbstractCompressedString>

toCharArray

public final char[] toCharArray()

Specified by:

toCharArray in interface StringAlike<TYPE extends AbstractCompressedString>

indexOf

public final int indexOf(CharSequence cs,
 int fromIndex)

Specified by:

indexOf in interface StringAlike<TYPE extends AbstractCompressedString>

indexOf

public final int indexOf(CharSequence cs)

Specified by:

indexOf in interface StringAlike<TYPE extends AbstractCompressedString>

lastIndexOf

public final int lastIndexOf(CharSequence cs,
 int fromIndex)

Specified by:

lastIndexOf in interface StringAlike<TYPE extends AbstractCompressedString>

lastIndexOf

public final int lastIndexOf(CharSequence cs)

Specified by:

lastIndexOf in interface StringAlike<TYPE extends AbstractCompressedString>

replace

public final TYPE replace(char oldChar,
 char newChar)

Specified by:

replace in interface StringAlike<TYPE extends AbstractCompressedString>

contains

public final boolean contains(CharSequence cs)

Specified by:

contains in interface StringAlike<TYPE extends AbstractCompressedString>

replaceFirst

public final TYPE replaceFirst(CharSequence regex,
 CharSequence replacement)

Specified by:

replaceFirst in interface StringAlike<TYPE extends AbstractCompressedString>

replaceAll

public final TYPE replaceAll(CharSequence regex,
 CharSequence replacement)

Specified by:

replaceAll in interface StringAlike<TYPE extends AbstractCompressedString>

replace

public final TYPE replace(CharSequence target,
 CharSequence replacement)

Specified by:

replace in interface StringAlike<TYPE extends AbstractCompressedString>

split

public final TYPE[] split(CharSequence regex,
 int limit)

Specified by:

split in interface StringAlike<TYPE extends AbstractCompressedString>

split

public final TYPE[] split(CharSequence regex)

Specified by:

split in interface StringAlike<TYPE extends AbstractCompressedString>

toLowerCase

public final TYPE toLowerCase(Locale locale)

Specified by:

toLowerCase in interface StringAlike<TYPE extends AbstractCompressedString>

toLowerCase

public final TYPE toLowerCase()

Specified by:

toLowerCase in interface StringAlike<TYPE extends AbstractCompressedString>

toUpperCase

public final TYPE toUpperCase(Locale locale)

Specified by:

toUpperCase in interface StringAlike<TYPE extends AbstractCompressedString>

toUpperCase

public final TYPE toUpperCase()

Specified by:

toUpperCase in interface StringAlike<TYPE extends AbstractCompressedString>

intern

public final TYPE intern()

Specified by:

intern in interface StringAlike<TYPE extends AbstractCompressedString>