Package com.yahoo.document.datatypes

Class Array<T extends FieldValue>

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.datatypes.FieldValue

com.yahoo.document.datatypes.CompositeFieldValue

com.yahoo.document.datatypes.CollectionFieldValue<T>

com.yahoo.document.datatypes.Array<T>

All Implemented Interfaces:

Cloneable, Comparable<FieldValue>, Iterable<T>, Collection<T>, List<T>

public final class Array<T extends FieldValue>
extends CollectionFieldValue<T>
implements List<T>

FieldValue which encapsulates an Array value

Author:

Einar M R Rosenvinge

Field Summary

Fields inherited from class com.yahoo.document.datatypes.FieldValue

classId

Constructor Summary

Constructors

Constructor	Description
Array(DataType type)
Array(DataType type, int initialCapacity)
Array(DataType type, List<T> values)

Method Summary

Modifier and Type	Method	Description
void	add(int index, T o)
boolean	add(T o)
boolean	addAll(int index, Collection<? extends T> c)
boolean	addAll(Collection<? extends T> c)
void	assign(Object o)	Assign this non-fieldvalue value to this field value.
void	clear()
Array<T>	clone()
int	compareTo(FieldValue fieldValue)
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
void	deserialize(Field field, FieldReader reader)	Read a field value from the specified reader
boolean	equals(Object o)
Iterator<T>	fieldValueIterator()
T	get(int index)
ArrayDataType	getDataType()
FieldValue	getFieldValue(int index)
List<T>	getValues()
Object	getWrappedValue()	Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values.
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
void	printXml(XmlStream xml)	Deprecated.
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	removeValue(FieldValue o)
boolean	retainAll(Collection<?> c)
void	serialize(Field field, FieldWriter writer)	Write out field value to the specified writer
T	set(int index, T o)
int	size()
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()

Methods inherited from class com.yahoo.document.datatypes.CollectionFieldValue

createFieldValue, isEmpty, removeValue, verifyElementCompatibility

Methods inherited from class com.yahoo.document.datatypes.CompositeFieldValue

setDataType

Methods inherited from class com.yahoo.document.datatypes.FieldValue

create, deserialize, getRecursiveValue, getRecursiveValue, onDeserialize, onSerialize, serialize, toXml

Methods inherited from class com.yahoo.vespa.objects.Identifiable

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, getClassId, getRawUtf8Bytes, getUtf8, onGetClassId, putUtf8, registerClass, registerClass, serialize, serializeOptional, serializeWithId, visitMembers

Methods inherited from class com.yahoo.vespa.objects.Selectable

select, select, selectMembers

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Constructor Details

Array

public Array(DataType type)

Array

public Array(DataType type,
 int initialCapacity)

Array

public Array(DataType type,
 List<T> values)

Method Details

getDataType

public ArrayDataType getDataType()

Overrides:

getDataType in class CollectionFieldValue<T extends FieldValue>

fieldValueIterator

public Iterator<T> fieldValueIterator()

Specified by:

fieldValueIterator in class CollectionFieldValue<T extends FieldValue>

clone

public Array<T> clone()

Overrides:

clone in class FieldValue

clear

public void clear()

Specified by:

clear in interface Collection<T extends FieldValue>

Specified by:

clear in interface List<T extends FieldValue>

Specified by:

clear in class FieldValue

assign

public void assign(Object o)

Description copied from class: FieldValue

Assign this non-fieldvalue value to this field value. This is used to be able to assign ints to Integer field values and List to Array field values and such.

Override to accept the specific types that should be legal.

Specified by:

assign in class FieldValue

getWrappedValue

public Object getWrappedValue()

Description copied from class: FieldValue

Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values. Complex types that can't be specified by simple java types just return themselves.

Overrides:

getWrappedValue in class FieldValue

getValues

public List<T> getValues()

getFieldValue

public FieldValue getFieldValue(int index)

printXml

@Deprecated
public void printXml(XmlStream xml)

Deprecated.

Specified by:

printXml in class FieldValue

toString

public String toString()

Overrides:

toString in class com.yahoo.vespa.objects.Identifiable

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T extends FieldValue>

Specified by:

hashCode in interface List<T extends FieldValue>

Overrides:

hashCode in class CompositeFieldValue

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T extends FieldValue>

Specified by:

equals in interface List<T extends FieldValue>

Overrides:

equals in class CompositeFieldValue

add

public void add(int index,
 T o)

Specified by:

add in interface List<T extends FieldValue>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T extends FieldValue>

Specified by:

remove in interface List<T extends FieldValue>

add

public boolean add(T o)

Specified by:

add in interface Collection<T extends FieldValue>

Specified by:

add in interface List<T extends FieldValue>

Specified by:

add in class CollectionFieldValue<T extends FieldValue>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T extends FieldValue>

Specified by:

contains in interface List<T extends FieldValue>

Specified by:

contains in class CollectionFieldValue<T extends FieldValue>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T extends FieldValue>

Specified by:

isEmpty in interface List<T extends FieldValue>

Specified by:

isEmpty in class CollectionFieldValue<T extends FieldValue>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T extends FieldValue>

Specified by:

iterator in interface Iterable<T extends FieldValue>

Specified by:

iterator in interface List<T extends FieldValue>

Specified by:

iterator in class CollectionFieldValue<T extends FieldValue>

removeValue

public boolean removeValue(FieldValue o)

Specified by:

removeValue in class CollectionFieldValue<T extends FieldValue>

size

public int size()

Specified by:

size in interface Collection<T extends FieldValue>

Specified by:

size in interface List<T extends FieldValue>

Specified by:

size in class CollectionFieldValue<T extends FieldValue>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T extends FieldValue>

Specified by:

addAll in interface List<T extends FieldValue>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T extends FieldValue>

Specified by:

containsAll in interface List<T extends FieldValue>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T extends FieldValue>

Specified by:

toArray in interface List<T extends FieldValue>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<T extends FieldValue>

Specified by:

toArray in interface List<T extends FieldValue>

addAll

public boolean addAll(int index,
 Collection<? extends T> c)

Specified by:

addAll in interface List<T extends FieldValue>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T extends FieldValue>

Specified by:

retainAll in interface List<T extends FieldValue>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T extends FieldValue>

Specified by:

removeAll in interface List<T extends FieldValue>

get

public T get(int index)

Specified by:

get in interface List<T extends FieldValue>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T extends FieldValue>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T extends FieldValue>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T extends FieldValue>

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T extends FieldValue>

remove

public T remove(int index)

Specified by:

remove in interface List<T extends FieldValue>

set

public T set(int index,
 T o)

Specified by:

set in interface List<T extends FieldValue>

subList

public List<T> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<T extends FieldValue>

serialize

public void serialize(Field field,
 FieldWriter writer)

Description copied from class: FieldValue

Write out field value to the specified writer

Specified by:

serialize in class FieldValue

deserialize

public void deserialize(Field field,
 FieldReader reader)

Description copied from class: FieldValue

Read a field value from the specified reader

Specified by:

deserialize in class FieldValue

compareTo

public int compareTo(FieldValue fieldValue)

Specified by:

compareTo in interface Comparable<T extends FieldValue>

Overrides:

compareTo in class FieldValue