Spec-Zone.ru › OpenJDK 8

Интерфейс TabularData

Все известные реализующие классы:
TabularDataSupport

public interface TabularData

Интерфейс TabularData определяет поведение специфических сложных объектов открытых данных, представляющих структуры табличных данных.

С момента:
1.5

Методы

Модификатор и тип Метод и описание
Object[] calculateIndex(CompositeData value)

Вычисляет индекс, который был бы использован в этом TabularData экземпляре для ссылки на указанный составной параметр данных value, если он был добавлен в этот экземпляр.

void clear()

Удаляет все CompositeData значения (т.е. строки) из этого TabularData экземпляра.

boolean containsKey(Object[] key)

Возвращает true тогда и только тогда, когда этот TabularData экземпляр содержит значение CompositeData (т.е. строку), индекс которого является указанным key.

boolean containsValue(CompositeData value)

Возвращает true тогда и только тогда, когда этот TabularData экземпляр содержит указанное значение CompositeData.

boolean equals(Object obj)

Сравнивает указанный параметр obj с этим TabularData экземпляром для равенства.

CompositeData get(Object[] key)

Возвращает значение CompositeData с индексом key, или null если в этом TabularData экземпляре нет значения, сопоставленного с key.

TabularType getTabularType()

Возвращает тип таблицы, описывающий этот TabularData экземпляр.

int hashCode()

Возвращает значение хэш-кода для этого TabularData экземпляра.

boolean isEmpty()

Возвращает true если число CompositeData значений (т.е. число строк) в этом TabularData экземпляре равно нулю.

Set<?> keySet()

Возвращает представление набора ключей (т.е. значений индексов) CompositeData значений (т.е. строк), содержащихся в этом TabularData экземпляре.

void put(CompositeData value)

Добавляет value к этому TabularData экземпляру.

void putAll(CompositeData[] values)

Добавляет все элементы в values к этому TabularData экземпляру.

CompositeData remove(Object[] key)

Удаляет значение CompositeData с индексом key из этого TabularData экземпляра и возвращает удаленное значение, или возвращает null если нет значения с индексом key.

int size()

Возвращает число CompositeData значений (т.е. число строк) в этом TabularData экземпляре.

String toString()

Возвращает строковое представление этого TabularData экземпляра.

Collection<?> values()

Возвращает коллекцию представлений CompositeData значений (т.е. строк), содержащихся в этом TabularData экземпляре.

Методы

getTabularType

TabularType getTabularType()

Возвращает тип таблицы, описывающий этот TabularData экземпляр.

Возвращает:
тип таблицы.

calculateIndex

Object[] calculateIndex(CompositeData value)

Вычисляет индекс, который будет использоваться в этом TabularData экземпляре для ссылки на указанные составные данные параметр value, если он был добавлен в этот экземпляр. Этот метод проверяет корректность типа указанного value, но не проверяет, используется ли вычисленный индекс для ссылки на значение в этом TabularData экземпляре.

Параметры:
value - значение составных данных, индекс которого в этом TabularData экземпляре необходимо вычислить; должно быть того же типа, что и тип строки этого экземпляра; не должно быть null.
Возвращает:
индекс, который имел бы указанное value в этом TabularData экземпляре.
Исключение:
NullPointerException - если value является null
InvalidOpenTypeException - если value не соответствует определению типа строки этого TabularData экземпляра.

size

int size()

Возвращает количество CompositeData значений (т.е. количество строк) в этом TabularData экземпляре.

Возвращает:
количество содержащихся значений.

isEmpty

boolean isEmpty()

Возвращает true , если количество CompositeData значений (т.е. количество строк) в этом TabularData экземпляре равно нулю.

Возвращает:
true, если этот TabularData пустой.

containsKey

boolean containsKey(Object[] key)

Возвращает true тогда и только тогда, когда этот TabularData экземпляр содержит CompositeData значение (т.е. строку), индекс которого совпадает с указанным key. Если key null или не соответствует определению типа строки этого TabularData экземпляра, этот метод просто возвращает false.

Параметры:
key - значение индекса, присутствие которого в этом TabularData экземпляре необходимо проверить.
Возвращает:
true если этот TabularData индексирует значение строки с указанным ключом.

containsValue

boolean containsValue(CompositeData value)

Возвращает true тогда и только тогда, когда этот TabularData экземпляр содержит указанное CompositeData значение. Если value null или не соответствует определению типа строки этого TabularData экземпляра, этот метод просто возвращает false.

Параметры:
value - значение строки, присутствие которого в этом TabularData экземпляре необходимо проверить.
Возвращает:
true если этот TabularData экземпляр содержит указанное значение строки.

get

CompositeData get(Object[] key)

Возвращает CompositeData значение, индекс которого key, или null если в этом TabularData экземпляре нет значения, сопоставленного с key.

Параметры:
key - ключ строки, которую необходимо вернуть.
Возвращает:
значение, соответствующее key.
Исключение:
NullPointerException - если key null
InvalidKeyException - если key не соответствует определению типа строки этого TabularData экземпляра * TabularType

put

void put(CompositeData value)

Добавляет value в этот TabularData экземпляр. Тип составных данных value должен быть таким же, как тип строки этого экземпляра (т.е. тип составных данных, возвращаемый this.getTabularType().getRowType()), и не должно быть уже существующего значения в этом TabularData экземпляре, индекс которого совпадает с вычисленным для добавляемого value. Индекс для value вычисляется в соответствии с определением TabularData экземпляра TabularType (см. TabularType.getIndexNames()).

Параметры:
value - значение составных данных, которое будет добавлено в качестве новой строки в этот TabularData экземпляр; должен быть того же типа, что и тип строки этого экземпляра; не должно быть null.
Исключение:
NullPointerException - если value null
InvalidOpenTypeException - если value не соответствует определению типа строки этого TabularData экземпляра.
KeyAlreadyExistsException - если индекс для value, вычисленный в соответствии с определением этого TabularData экземпляра TabularType уже сопоставлен с существующим значением в базовом HashMap.

remove

CompositeData remove(Object[] key)

Удаляет CompositeData значение, индекс которого key, из этого TabularData экземпляра и возвращает удаленное значение или возвращает null , если значения с индексом key нет.

Параметры:
key - индекс значения, которое нужно получить в этом TabularData экземпляре; должен быть допустим с определением типа строки этого TabularData экземпляра; не должно быть null.
Возвращает:
предыдущее значение, связанное с указанным ключом, или null если сопоставления для ключа не было.
Исключение:
NullPointerException - если key null
InvalidKeyException - если key не соответствует определению типа строки этого TabularData экземпляра TabularType

putAll

void putAll(CompositeData[] values)

Добавляет все элементы в values в этот TabularData экземпляр. Если какой-либо элемент в values не удовлетворяет ограничениям, определенным в put, или если какие-либо два элемента в values имеют одинаковый индекс, рассчитанный в соответствии с определением этого TabularData экземпляра TabularType, то выбрасывается исключение, описывающее ошибку, и ни один элемент values не добавляется, тем самым оставляя этот TabularData экземпляр неизменным.

Параметры:
values - массив значений составных данных, которые необходимо добавить в качестве новых строк в этот TabularData экземпляр; если values null или пуст, этот метод возвращается без каких-либо действий.
Исключение:
NullPointerException - если элемент values null
InvalidOpenTypeException - если элемент values не соответствует определению типа строки этого TabularData экземпляра.
KeyAlreadyExistsException - если индекс для элемента values, вычисленный в соответствии с определением этого TabularData экземпляра TabularType уже сопоставлен с существующим значением в этом экземпляре или два элемента из values имеют одинаковый индекс.

clear

void clear()

Удаляет все CompositeData значения (т.е. строки) из этого TabularData экземпляра.

keySet

Set<?> keySet()

Возвращает представление набора ключей (т.е. значений индекса) CompositeData значений (т.е. строк), содержащихся в этом TabularData экземпляре. Возвращаемый Set является Set<List<?>>, но объявлен как Set<?> по причинам совместимости. Возвращаемый набор может быть использован для итерации по ключам.

Возвращает:
представление набора (Set<List<?>>) значений индекса, используемых в этом TabularData экземпляре.

values

Collection<?> values()

Возвращает представление коллекции CompositeData значений (т.е. строк), содержащихся в этом TabularData экземпляре. Возвращаемая Collection коллекция является Collection<CompositeData>, но объявлена как Collection<?> по причинам совместимости. Возвращаемую коллекцию можно использовать для итерации по значениям.

Возвращает:
представление коллекции (Collection<CompositeData>) содержащихся в этом TabularData экземпляре строк.

equals

boolean equals(Object obj)

Сравнивает указанный параметр obj с этим TabularData экземпляром на равенство.

Возвращает true тогда и только тогда, когда все следующие утверждения истинны:

  • obj не равен null,
  • obj также реализует интерфейс TabularData,
  • их типы строк равны
  • их содержимое (т.е. соответствия индекс-значение) равны
Это гарантирует, что этот equals метод работает должным образом для параметров obj, которые являются различными реализациями интерфейса TabularData.
Переопределяет:
equals в классе Object
Параметры:
obj - объект, который необходимо сравнить на равенство с этим TabularData экземпляром;
Возвращает:
true если указанный объект равен этому TabularData экземпляру.
См. также:
Object.hashCode(), HashMap

hashCode

int hashCode()

Возвращает значение хэш-кода для этого TabularData экземпляра.

Хэш-код TabularData экземпляра является суммой хэш-кодов всех элементов информации, используемых в equals сравнениях (т.е.: его тип таблицы и его содержимое, где содержимое определяется как все соответствия индекс-значение).

Это гарантирует, что t1.equals(t2) подразумевает, что t1.hashCode()==t2.hashCode() для любых двух TabularDataSupport экземпляров t1 и t2, как того требует общий контракт метода Object.hashCode().

Переопределяет:
hashCode в классе Object
Возвращает:
значение хэш-кода для этого TabularDataSupport экземпляра
См. также:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

String toString()

Возвращает строковое представление этого TabularData экземпляра.

Строковое представление состоит из имени реализуемого класса и табличного типа этого экземпляра.

Переопределяет:
toString в классе Object
Возвращает:
строковое представление этого TabularData экземпляра

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API