Class LazyStringArrayList
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<java.lang.String>
-
- com.google.protobuf.LazyStringArrayList
-
- All Implemented Interfaces:
LazyStringList
,ProtocolStringList
,java.lang.Iterable<java.lang.String>
,java.util.Collection<java.lang.String>
,java.util.List<java.lang.String>
,java.util.RandomAccess
public class LazyStringArrayList extends java.util.AbstractList<java.lang.String> implements LazyStringList, java.util.RandomAccess
An implementation ofLazyStringList
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.
- Author:
- jonp@google.com (Jon Perlow)
-
-
Field Summary
Fields Modifier and Type Field Description static LazyStringList
EMPTY
-
Constructor Summary
Constructors Constructor Description LazyStringArrayList()
LazyStringArrayList(LazyStringList from)
LazyStringArrayList(java.util.List<java.lang.String> from)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(byte[] element)
Appends the specified element to the end of this list (optional operation).void
add(int index, java.lang.String element)
void
add(ByteString element)
Appends the specified element to the end of this list (optional operation).boolean
addAll(int index, java.util.Collection<? extends java.lang.String> c)
boolean
addAll(java.util.Collection<? extends java.lang.String> c)
boolean
addAllByteArray(java.util.Collection<byte[]> c)
Appends all elements in the specified byte[] collection to the end of this list.boolean
addAllByteString(java.util.Collection<? extends ByteString> values)
Appends all elements in the specified ByteString collection to the end of this list.java.util.List<byte[]>
asByteArrayList()
Returns a mutable view of this list.java.util.List<ByteString>
asByteStringList()
Returns a view of the data as a list of ByteStrings.void
clear()
java.lang.String
get(int index)
byte[]
getByteArray(int index)
Returns the element at the specified position in this list as byte[].ByteString
getByteString(int index)
Returns the element at the specified position in this list as a ByteString.java.util.List<?>
getUnderlyingElements()
Returns an unmodifiable List of the underlying elements, each of which is either aString
or its equivalent UTF-8 encodedByteString
or byte[].LazyStringList
getUnmodifiableView()
Returns an unmodifiable view of the list.void
mergeFrom(LazyStringList other)
Merges all elements from another LazyStringList into this one.java.lang.String
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).java.lang.String
set(int index, java.lang.String s)
int
size()
-
Methods inherited from class java.util.AbstractList
add, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList
-
Methods inherited from class java.util.AbstractCollection
contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
-
-
-
-
Field Detail
-
EMPTY
public static final LazyStringList EMPTY
-
-
Constructor Detail
-
LazyStringArrayList
public LazyStringArrayList()
-
LazyStringArrayList
public LazyStringArrayList(LazyStringList from)
-
LazyStringArrayList
public LazyStringArrayList(java.util.List<java.lang.String> from)
-
-
Method Detail
-
get
public java.lang.String get(int index)
- Specified by:
get
in interfacejava.util.List<java.lang.String>
- Specified by:
get
in classjava.util.AbstractList<java.lang.String>
-
size
public int size()
- Specified by:
size
in interfacejava.util.Collection<java.lang.String>
- Specified by:
size
in interfacejava.util.List<java.lang.String>
- Specified by:
size
in classjava.util.AbstractCollection<java.lang.String>
-
set
public java.lang.String set(int index, java.lang.String s)
- Specified by:
set
in interfacejava.util.List<java.lang.String>
- Overrides:
set
in classjava.util.AbstractList<java.lang.String>
-
add
public void add(int index, java.lang.String element)
- Specified by:
add
in interfacejava.util.List<java.lang.String>
- Overrides:
add
in classjava.util.AbstractList<java.lang.String>
-
addAll
public boolean addAll(java.util.Collection<? extends java.lang.String> c)
- Specified by:
addAll
in interfacejava.util.Collection<java.lang.String>
- Specified by:
addAll
in interfacejava.util.List<java.lang.String>
- Overrides:
addAll
in classjava.util.AbstractCollection<java.lang.String>
-
addAll
public boolean addAll(int index, java.util.Collection<? extends java.lang.String> c)
- Specified by:
addAll
in interfacejava.util.List<java.lang.String>
- Overrides:
addAll
in classjava.util.AbstractList<java.lang.String>
-
addAllByteString
public boolean addAllByteString(java.util.Collection<? extends ByteString> values)
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
public boolean addAllByteArray(java.util.Collection<byte[]> c)
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
public java.lang.String remove(int index)
- Specified by:
remove
in interfacejava.util.List<java.lang.String>
- Overrides:
remove
in classjava.util.AbstractList<java.lang.String>
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Collection<java.lang.String>
- Specified by:
clear
in interfacejava.util.List<java.lang.String>
- Overrides:
clear
in classjava.util.AbstractList<java.lang.String>
-
add
public void add(ByteString 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
-
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
-
getByteString
public ByteString getByteString(int index)
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
public void set(int index, ByteString 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
-
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
-
getUnderlyingElements
public java.util.List<?> 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
public void mergeFrom(LazyStringList other)
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
public java.util.List<byte[]> 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
public java.util.List<ByteString> asByteStringList()
Description copied from interface:ProtocolStringList
Returns a view of the data as a list of ByteStrings.- Specified by:
asByteStringList
in interfaceProtocolStringList
-
getUnmodifiableView
public LazyStringList getUnmodifiableView()
Description copied from interface:LazyStringList
Returns an unmodifiable view of the list.- Specified by:
getUnmodifiableView
in interfaceLazyStringList
-
-