Package io.deephaven.vector
Interface ObjectVector<COMPONENT_TYPE>
- All Superinterfaces:
Iterable<COMPONENT_TYPE>
,LongSizedDataStructure
,Serializable
,Vector<ObjectVector<COMPONENT_TYPE>>
- All Known Implementing Classes:
InstantSsmSourceWrapper.ValueWrapper
,ObjectRingBufferVectorWrapper
,ObjectSegmentedSortedMultiset
,ObjectSubVector
,ObjectVector.Indirect
,ObjectVectorColumnWrapper
,ObjectVectorDirect
,ObjectVectorSlice
public interface ObjectVector<COMPONENT_TYPE>
extends Vector<ObjectVector<COMPONENT_TYPE>>, Iterable<COMPONENT_TYPE>
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Base class for all "indirect" ObjectVector implementations. -
Field Summary
Fields inherited from interface io.deephaven.vector.Vector
NULL_ELEMENT_STRING
-
Method Summary
Modifier and TypeMethodDescriptionGet an array representation of the elements of this Vector.static String
defaultValToString
(Object val) static boolean
equals
(@NotNull ObjectVector<?> aVector, @Nullable Object bObj) Helper method for implementingObject.equals(Object)
.get
(long index) Get the element of this ObjectVector at offsetindex
.static int
hashCode
(@NotNull ObjectVector<?> vector) Helper method for implementingObject.hashCode()
.default CloseableIterator<COMPONENT_TYPE>
iterator()
default CloseableIterator<COMPONENT_TYPE>
iterator
(long fromIndexInclusive, long toIndexExclusive) Returns an iterator over a slice of this ObjectVector, with equivalent semantics tosubVector(fromIndexInclusive, toIndexExclusive).iterator()
.subVector
(long fromIndexInclusive, long toIndexExclusive) Get a Vector that represents a slice of this Vector.subVectorByPositions
(long[] positions) Get a Vector that represents a set of offset positions in this Vector.toArray()
Get an array representation of the elements of this Vector.default String
toString
(int prefixLength) Get a String representation of a prefix of this Vector.static String
toString
(@NotNull ObjectVector<?> vector, int prefixLength) Helper method for implementingObject.toString()
.static <T> GenericVectorType<ObjectVector<T>,
T> type
(GenericType<T> genericType) Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface io.deephaven.util.datastructures.LongSizedDataStructure
intSize, intSize, size
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
-
Method Details
-
type
-
get
Get the element of this ObjectVector at offsetindex
. Ifindex
is not within range[0, size())
, will returnnull
.- Parameters:
index
- An offset into this ObjectVector- Returns:
- The element at the specified offset, or
null
-
subVector
Description copied from interface:Vector
Get a Vector that represents a slice of this Vector.- Specified by:
subVector
in interfaceVector<COMPONENT_TYPE>
- Parameters:
fromIndexInclusive
- The first offset into this Vector to include in the result; if negative, the result will have a range of null values at offsets in[0, -fromIndexInclusive)
toIndexExclusive
- The first offset into this Vector to not include in the result; if larger thansize()
, the result will have a range of null values at the corresponding offsets- Returns:
- The sub-Vector specified by
[fromIndexInclusive, toIndexExclusive)
-
subVectorByPositions
Description copied from interface:Vector
Get a Vector that represents a set of offset positions in this Vector.- Specified by:
subVectorByPositions
in interfaceVector<COMPONENT_TYPE>
- Parameters:
positions
- The offsets to include; if not within[0, size())
, the corresponding offset in the result will contain the appropriate null value- Returns:
- The sub-Vector specified by
positions
-
toArray
COMPONENT_TYPE[] toArray()Description copied from interface:Vector
Get an array representation of the elements of this Vector. Callers must not mutate the result, as implementations may choose to return their backing array in some cases.- Specified by:
toArray
in interfaceVector<COMPONENT_TYPE>
- Returns:
- An array representation of the elements of this Vector that must not be mutated
-
copyToArray
COMPONENT_TYPE[] copyToArray()Description copied from interface:Vector
Get an array representation of the elements of this Vector. Callers may freely mutate the result, as it is guaranteed to be freshly-allocated and belongs to the caller upon return.- Specified by:
copyToArray
in interfaceVector<COMPONENT_TYPE>
- Returns:
- An array representation of the elements of this Vector that may be freely mutated
-
getDirect
ObjectVector<COMPONENT_TYPE> getDirect()- Specified by:
getDirect
in interfaceVector<COMPONENT_TYPE>
- Returns:
- A version of this Vector that is flattened out to only reference memory
-
getComponentType
Class<COMPONENT_TYPE> getComponentType()- Specified by:
getComponentType
in interfaceVector<COMPONENT_TYPE>
- Returns:
- The type of elements contained by this Vector
-
iterator
- Specified by:
iterator
in interfaceIterable<COMPONENT_TYPE>
-
iterator
Returns an iterator over a slice of this ObjectVector, with equivalent semantics tosubVector(fromIndexInclusive, toIndexExclusive).iterator()
.- Parameters:
fromIndexInclusive
- The first position to includetoIndexExclusive
- The first position afterfromIndexInclusive
to not include- Returns:
- An iterator over the requested slice
-
toString
Description copied from interface:Vector
Get a String representation of a prefix of this Vector.- Specified by:
toString
in interfaceVector<COMPONENT_TYPE>
- Parameters:
prefixLength
- The number of elements to include- Returns:
- The specified prefix String representation
-
defaultValToString
-
toString
Helper method for implementingObject.toString()
.- Parameters:
vector
- The ObjectVector to convert to a StringprefixLength
- The maximum prefix ofvector
to convert- Returns:
- The String representation of
vector
-
equals
Helper method for implementingObject.equals(Object)
.- Parameters:
aVector
- The LHS of the equality test (always an ObjectVector)bObj
- The RHS of the equality test- Returns:
- Whether the two inputs are equal
-
hashCode
Helper method for implementingObject.hashCode()
. Follows the pattern inArrays.hashCode(Object[])
.- Parameters:
vector
- The ObjectVector to hash- Returns:
- The hash code
-