Class LazyStringArrayList
- All Implemented Interfaces:
Internal.ProtobufList<String>,LazyStringList,ProtocolStringList,Iterable<String>,Collection<String>,List<String>,RandomAccess
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 ArrayList 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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static classprivate static class -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final LazyStringListDeprecated.private static final LazyStringArrayListFields inherited from class com.google.protobuf.AbstractProtobufList
DEFAULT_CAPACITYFields inherited from class java.util.AbstractList
modCount -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateLazyStringArrayList(boolean isMutable) LazyStringArrayList(int initialCapacity) privateLazyStringArrayList(ArrayList<Object> list) LazyStringArrayList(List<String> from) -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(byte[] element) Appends the specified element to the end of this list (optional operation).private voidadd(int index, byte[] element) private voidadd(int index, ByteString element) voidvoidadd(ByteString element) Appends the specified element to the end of this list (optional operation).booleanaddAll(int index, Collection<? extends String> c) booleanaddAll(Collection<? extends String> c) booleanaddAllByteArray(Collection<byte[]> c) Appends all elements in the specified byte[] collection to the end of this list.booleanaddAllByteString(Collection<? extends ByteString> values) Appends all elements in the specified ByteString collection to the end of this list.private static byte[]List<byte[]>Returns a mutable view of this list.private static ByteStringReturns a view of the data as a list of ByteStrings.private static Stringvoidclear()static LazyStringArrayListReturns an empty immutableLazyStringArrayListinstanceget(int index) byte[]getByteArray(int index) Returns the element at the specified position in this list as byte[].getByteString(int index) Returns the element at the specified position in this list as a ByteString.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.List<?>Returns an unmodifiable List of the underlying elements, each of which is either aStringor its equivalent UTF-8 encodedByteStringor byte[].Returns an unmodifiable view of the list.voidmergeFrom(LazyStringList other) Merges all elements from another LazyStringList into this one.mutableCopyWithCapacity(int capacity) Returns a mutable clone of this list with the specified capacity.remove(int index) voidset(int index, byte[] s) Replaces the element at the specified position in this list with the specified element (optional operation).voidset(int index, ByteString s) Replaces the element at the specified position in this list with the specified element (optional operation).private ObjectsetAndReturn(int index, byte[] s) private ObjectsetAndReturn(int index, ByteString s) intsize()Methods inherited from class com.google.protobuf.AbstractProtobufList
add, ensureIsMutable, equals, hashCode, isModifiable, makeImmutable, remove, removeAll, retainAllMethods inherited from class java.util.AbstractList
indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subListMethods inherited from class java.util.AbstractCollection
contains, containsAll, isEmpty, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface java.util.List
add, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, replaceAll, retainAll, sort, spliterator, subList, toArray, toArray
-
Field Details
-
EMPTY_LIST
-
EMPTY
Deprecated.useemptyList()insteadFor compatibility with older runtimes.TODO Remove this in a breaking release.
-
list
-
-
Constructor Details
-
LazyStringArrayList
public LazyStringArrayList() -
LazyStringArrayList
private LazyStringArrayList(boolean isMutable) -
LazyStringArrayList
public LazyStringArrayList(int initialCapacity) -
LazyStringArrayList
-
LazyStringArrayList
-
LazyStringArrayList
-
-
Method Details
-
emptyList
Returns an empty immutableLazyStringArrayListinstance -
mutableCopyWithCapacity
Description copied from interface:Internal.ProtobufListReturns a mutable clone of this list with the specified capacity.- Specified by:
mutableCopyWithCapacityin interfaceInternal.ProtobufList<String>
-
get
-
size
public int size()- Specified by:
sizein interfaceCollection<String>- Specified by:
sizein interfaceList<String>- Specified by:
sizein classAbstractCollection<String>
-
set
-
add
-
add
-
add
private void add(int index, byte[] element) -
addAll
- Specified by:
addAllin interfaceCollection<String>- Specified by:
addAllin interfaceList<String>- Overrides:
addAllin classAbstractProtobufList<String>
-
addAll
-
addAllByteString
Description copied from interface:LazyStringListAppends all elements in the specified ByteString collection to the end of this list.- Specified by:
addAllByteStringin interfaceLazyStringList- Parameters:
values- collection whose elements are to be added to this list- Returns:
- true if this list changed as a result of the call
-
addAllByteArray
Description copied from interface:LazyStringListAppends all elements in the specified byte[] collection to the end of this list.- Specified by:
addAllByteArrayin interfaceLazyStringList- Parameters:
c- collection whose elements are to be added to this list- Returns:
- true if this list changed as a result of the call
-
remove
-
clear
public void clear()- Specified by:
clearin interfaceCollection<String>- Specified by:
clearin interfaceList<String>- Overrides:
clearin classAbstractProtobufList<String>
-
add
Description copied from interface:LazyStringListAppends the specified element to the end of this list (optional operation).- Specified by:
addin interfaceLazyStringList- Parameters:
element- element to be appended to this list
-
add
public void add(byte[] element) Description copied from interface:LazyStringListAppends the specified element to the end of this list (optional operation).- Specified by:
addin interfaceLazyStringList- Parameters:
element- element to be appended to this list
-
getRaw
Description copied from interface:LazyStringListReturns the element at the specified position in this list as an Object that will either be a String or a ByteString.- Specified by:
getRawin interfaceLazyStringList- Parameters:
index- index of the element to return- Returns:
- the element at the specified position in this list
-
getByteString
Description copied from interface:LazyStringListReturns the element at the specified position in this list as a ByteString.- Specified by:
getByteStringin interfaceLazyStringList- Parameters:
index- index of the element to return- Returns:
- the element at the specified position in this list
-
getByteArray
public byte[] getByteArray(int index) Description copied from interface:LazyStringListReturns the element at the specified position in this list as byte[].- Specified by:
getByteArrayin interfaceLazyStringList- Parameters:
index- index of the element to return- Returns:
- the element at the specified position in this list
-
set
Description copied from interface:LazyStringListReplaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
setin interfaceLazyStringList- Parameters:
index- index of the element to replaces- the element to be stored at the specified position
-
setAndReturn
-
set
public void set(int index, byte[] s) Description copied from interface:LazyStringListReplaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
setin interfaceLazyStringList- Parameters:
index- index of the element to replaces- the element to be stored at the specified position
-
setAndReturn
-
asString
-
asByteString
-
asByteArray
-
getUnderlyingElements
Description copied from interface:LazyStringListReturns an unmodifiable List of the underlying elements, each of which is either aStringor its equivalent UTF-8 encodedByteStringor byte[]. It is an error for the caller to modify the returned List, and attempting to do so will result in anUnsupportedOperationException.- Specified by:
getUnderlyingElementsin interfaceLazyStringList
-
mergeFrom
Description copied from interface:LazyStringListMerges all elements from another LazyStringList into this one. This method differs fromList.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.- Specified by:
mergeFromin interfaceLazyStringList
-
asByteArrayList
Description copied from interface:LazyStringListReturns 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.- Specified by:
asByteArrayListin interfaceLazyStringList
-
asByteStringList
Description copied from interface:ProtocolStringListReturns a view of the data as a list of ByteStrings.- Specified by:
asByteStringListin interfaceProtocolStringList
-
getUnmodifiableView
Description copied from interface:LazyStringListReturns an unmodifiable view of the list.- Specified by:
getUnmodifiableViewin interfaceLazyStringList
-
emptyList()instead