Class LazyStringArrayList

public class LazyStringArrayList extends AbstractProtobufList<String> implements LazyStringList, RandomAccess

An implementation of LazyStringList that wraps an ArrayList. Each element is one of String, ByteString, or byte[]. It caches the last one requested which is most likely the one needed next. This minimizes memory usage while satisfying the most common use cases.

Note that this implementation is not synchronized. If multiple threads access an instance concurrently, and at least one of the threads modifies the list structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more elements, or explicitly resizes the backing array; merely setting the value of an element is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the list.

If the implementation is accessed via concurrent reads, this is thread safe. Conversions are done in a thread safe manner. It's possible that the conversion may happen more than once if two threads attempt to access the same element and the modifications were not visible to each other, but this will not result in any corruption of the list or change in behavior other than performance.

Inheritance

Object > java.util.AbstractCollection > AbstractList > com.google.protobuf.AbstractProtobufList > LazyStringArrayList

Static Fields

EMPTY

public static final LazyStringList EMPTY
Field Value
TypeDescription
LazyStringList

Constructors

LazyStringArrayList()

public LazyStringArrayList()

LazyStringArrayList(LazyStringList from)

public LazyStringArrayList(LazyStringList from)
Parameter
NameDescription
fromLazyStringList

LazyStringArrayList(int initialCapacity)

public LazyStringArrayList(int initialCapacity)
Parameter
NameDescription
initialCapacityint

LazyStringArrayList(List<String> from)

public LazyStringArrayList(List<String> from)
Parameter
NameDescription
fromList<String>

Methods

add(byte[] element)

public void add(byte[] element)

Appends the specified element to the end of this list (optional operation).

Parameter
NameDescription
elementbyte[]

add(ByteString element)

public void add(ByteString element)

Appends the specified element to the end of this list (optional operation).

Parameter
NameDescription
elementByteString

add(int index, String element)

public void add(int index, String element)
Parameters
NameDescription
indexint
elementString
Overrides
com.google.protobuf.AbstractProtobufList.add(int,E)

addAll(int index, Collection<? extends String> c)

public boolean addAll(int index, Collection<? extends String> c)
Parameters
NameDescription
indexint
cCollection<? extends java.lang.String>
Returns
TypeDescription
boolean
Overrides
com.google.protobuf.AbstractProtobufList.addAll(int,java.util.Collection<? extends E>)

addAll(Collection<? extends String> c)

public boolean addAll(Collection<? extends String> c)
Parameter
NameDescription
cCollection<? extends java.lang.String>
Returns
TypeDescription
boolean
Overrides
com.google.protobuf.AbstractProtobufList.addAll(java.util.Collection<? extends E>)

addAllByteArray(Collection<byte[]> c)

public boolean addAllByteArray(Collection<byte[]> c)

Appends all elements in the specified byte[] collection to the end of this list.

Parameter
NameDescription
cCollection<byte[]>
Returns
TypeDescription
boolean

addAllByteString(Collection<? extends ByteString> values)

public boolean addAllByteString(Collection<? extends ByteString> values)

Appends all elements in the specified ByteString collection to the end of this list.

Parameter
NameDescription
valuesCollection<? extends com.google.protobuf.ByteString>
Returns
TypeDescription
boolean

asByteArrayList()

public List<byte[]> asByteArrayList()

Returns a mutable view of this list. Changes to the view will be made into the original list. This method is used in mutable API only.

Returns
TypeDescription
List<byte[]>

asByteStringList()

public List<ByteString> asByteStringList()

Returns a view of the data as a list of ByteStrings.

Returns
TypeDescription
List<ByteString>

clear()

public void clear()
Overrides
com.google.protobuf.AbstractProtobufList.clear()

get(int index)

public String get(int index)
Parameter
NameDescription
indexint
Returns
TypeDescription
String
Overrides

getByteArray(int index)

public byte[] getByteArray(int index)

Returns the element at the specified position in this list as byte[].

Parameter
NameDescription
indexint
Returns
TypeDescription
byte[]

getByteString(int index)

public ByteString getByteString(int index)

Returns the element at the specified position in this list as a ByteString.

Parameter
NameDescription
indexint
Returns
TypeDescription
ByteString

getRaw(int index)

public Object getRaw(int index)

Returns the element at the specified position in this list as an Object that will either be a String or a ByteString.

Parameter
NameDescription
indexint
Returns
TypeDescription
Object

getUnderlyingElements()

public List<?> getUnderlyingElements()

Returns an unmodifiable List of the underlying elements, each of which is either a String or its equivalent UTF-8 encoded ByteString or byte[]. It is an error for the caller to modify the returned List, and attempting to do so will result in an UnsupportedOperationException.

Returns
TypeDescription
List<?>

getUnmodifiableView()

public LazyStringList getUnmodifiableView()

Returns an unmodifiable view of the list.

Returns
TypeDescription
LazyStringList

mergeFrom(LazyStringList other)

public void mergeFrom(LazyStringList other)

Merges all elements from another LazyStringList into this one. This method differs from #addAll(Collection) on that underlying byte arrays are copied instead of reference shared. Immutable API doesn't need to use this method as byte[] is not used there at all.

Parameter
NameDescription
otherLazyStringList

mutableCopyWithCapacity(int capacity)

public LazyStringArrayList mutableCopyWithCapacity(int capacity)
Parameter
NameDescription
capacityint
Returns
TypeDescription
LazyStringArrayList

remove(int index)

public String remove(int index)
Parameter
NameDescription
indexint
Returns
TypeDescription
String
Overrides
com.google.protobuf.AbstractProtobufList.remove(int)

set(int index, byte[] s)

public void set(int index, byte[] s)

Replaces the element at the specified position in this list with the specified element (optional operation).

Parameters
NameDescription
indexint
sbyte[]

set(int index, ByteString s)

public void set(int index, ByteString s)

Replaces the element at the specified position in this list with the specified element (optional operation).

Parameters
NameDescription
indexint
sByteString

set(int index, String s)

public String set(int index, String s)
Parameters
NameDescription
indexint
sString
Returns
TypeDescription
String
Overrides
com.google.protobuf.AbstractProtobufList.set(int,E)

size()

public int size()
Returns
TypeDescription
int
Overrides