Class LazyStringArrayList
- All Implemented Interfaces:
Internal.ProtobufList<String>
,LazyStringList
,ProtocolStringList
,Iterable<String>
,Collection<String>
,List<String>
,RandomAccess
,SequencedCollection<String>
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 class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final LazyStringList
Deprecated.private static final LazyStringArrayList
Fields inherited from class com.google.protobuf.AbstractProtobufList
DEFAULT_CAPACITY
Fields inherited from class java.util.AbstractList
modCount
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
LazyStringArrayList
(boolean isMutable) LazyStringArrayList
(int initialCapacity) private
LazyStringArrayList
(ArrayList<Object> list) LazyStringArrayList
(List<String> from) -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(byte[] element) Appends the specified element to the end of this list (optional operation).private void
add
(int index, byte[] element) private void
add
(int index, ByteString element) void
void
add
(ByteString element) Appends the specified element to the end of this list (optional operation).boolean
boolean
addAll
(int index, Collection<? extends String> c) boolean
addAll
(Collection<? extends String> c) boolean
addAllByteArray
(Collection<byte[]> c) Appends all elements in the specified byte[] collection to the end of this list.boolean
addAllByteString
(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 ByteString
Returns a view of the data as a list of ByteStrings.private static String
void
clear()
static LazyStringArrayList
Returns an empty immutableLazyStringArrayList
instanceget
(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 aString
or its equivalent UTF-8 encodedByteString
or byte[].Returns an unmodifiable view of the list.void
mergeFrom
(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) void
set
(int index, byte[] s) Replaces the element at the specified position in this list with the specified element (optional operation).void
set
(int index, ByteString s) Replaces the element at the specified position in this list with the specified element (optional operation).private Object
setAndReturn
(int index, byte[] s) private Object
setAndReturn
(int index, ByteString s) int
size()
Methods inherited from class com.google.protobuf.AbstractProtobufList
ensureIsMutable, equals, hashCode, isModifiable, makeImmutable, remove, removeAll, retainAll
Methods inherited from class java.util.AbstractList
indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList
Methods inherited from class java.util.AbstractCollection
contains, containsAll, isEmpty, toArray, toArray, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
Methods inherited from interface java.util.List
addFirst, addLast, contains, containsAll, equals, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, 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 immutableLazyStringArrayList
instance -
mutableCopyWithCapacity
Description copied from interface:Internal.ProtobufList
Returns a mutable clone of this list with the specified capacity.- Specified by:
mutableCopyWithCapacity
in interfaceInternal.ProtobufList<String>
-
get
-
size
public int size()- Specified by:
size
in interfaceCollection<String>
- Specified by:
size
in interfaceList<String>
- Specified by:
size
in classAbstractCollection<String>
-
set
-
add
-
add
-
add
private void add(int index, byte[] element) -
add
- Specified by:
add
in interfaceCollection<String>
- Specified by:
add
in interfaceList<String>
- Overrides:
add
in classAbstractProtobufList<String>
-
add
Description copied from interface:LazyStringList
Appends the specified element to the end of this list (optional operation).- Specified by:
add
in interfaceLazyStringList
- Parameters:
element
- element to be appended to this list
-
add
public void add(byte[] element) Description copied from interface:LazyStringList
Appends the specified element to the end of this list (optional operation).- Specified by:
add
in interfaceLazyStringList
- Parameters:
element
- element to be appended to this list
-
addAll
- Specified by:
addAll
in interfaceCollection<String>
- Specified by:
addAll
in interfaceList<String>
- Overrides:
addAll
in classAbstractProtobufList<String>
-
addAll
-
addAllByteString
Description copied from interface:LazyStringList
Appends all elements in the specified ByteString collection to the end of this list.- Specified by:
addAllByteString
in 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:LazyStringList
Appends all elements in the specified byte[] collection to the end of this list.- Specified by:
addAllByteArray
in 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:
clear
in interfaceCollection<String>
- Specified by:
clear
in interfaceList<String>
- Overrides:
clear
in classAbstractProtobufList<String>
-
getRaw
Description copied from interface:LazyStringList
Returns the element at the specified position in this list as an Object that will either be a String or a ByteString.- Specified by:
getRaw
in interfaceLazyStringList
- Parameters:
index
- index of the element to return- Returns:
- the element at the specified position in this list
-
getByteString
Description copied from interface:LazyStringList
Returns the element at the specified position in this list as a ByteString.- Specified by:
getByteString
in 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:LazyStringList
Returns the element at the specified position in this list as byte[].- Specified by:
getByteArray
in interfaceLazyStringList
- Parameters:
index
- index of the element to return- Returns:
- the element at the specified position in this list
-
set
Description copied from interface:LazyStringList
Replaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
set
in 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:LazyStringList
Replaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
set
in 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:LazyStringList
Returns an unmodifiable List of the underlying elements, each of which is either aString
or its equivalent UTF-8 encodedByteString
or byte[]. It is an error for the caller to modify the returned List, and attempting to do so will result in anUnsupportedOperationException
.- Specified by:
getUnderlyingElements
in interfaceLazyStringList
-
mergeFrom
Description copied from interface:LazyStringList
Merges 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:
mergeFrom
in interfaceLazyStringList
-
asByteArrayList
Description copied from interface:LazyStringList
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.- Specified by:
asByteArrayList
in interfaceLazyStringList
-
asByteStringList
Description copied from interface:ProtocolStringList
Returns a view of the data as a list of ByteStrings.- Specified by:
asByteStringList
in interfaceProtocolStringList
-
getUnmodifiableView
Description copied from interface:LazyStringList
Returns an unmodifiable view of the list.- Specified by:
getUnmodifiableView
in interfaceLazyStringList
-
emptyList()
instead