Интерфейс TabularData
- Все известные реализующие классы:
- TabularDataSupport
public interface TabularData
Интерфейс TabularData определяет поведение специфических сложных объектов открытых данных, представляющих структуры табличных данных.
- С момента:
- 1.5
Методы
| Модификатор и тип | Метод и описание |
|---|---|
Object[] |
calculateIndex(CompositeData value) Вычисляет индекс, который был бы использован в этом |
void |
clear() Удаляет все |
boolean |
containsKey(Object[] key) Возвращает |
boolean |
containsValue(CompositeData value) Возвращает |
boolean |
equals(Object obj) Сравнивает указанный параметр obj с этим |
CompositeData |
get(Object[] key) Возвращает значение |
TabularType |
getTabularType() Возвращает тип таблицы, описывающий этот |
int |
hashCode() Возвращает значение хэш-кода для этого |
boolean |
isEmpty() Возвращает |
Set<?> |
keySet() Возвращает представление набора ключей (т.е. значений индексов) |
void |
put(CompositeData value) Добавляет value к этому |
void |
putAll(CompositeData[] values) Добавляет все элементы в values к этому |
CompositeData |
remove(Object[] key) Удаляет значение |
int |
size() Возвращает число |
String |
toString() Возвращает строковое представление этого |
Collection<?> |
values() Возвращает коллекцию представлений |
Методы
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- если keynull -
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- если valuenull -
InvalidOpenTypeException- если value не соответствует определению типа строки этогоTabularDataэкземпляра. -
KeyAlreadyExistsException- если индекс для value, вычисленный в соответствии с определением этогоTabularDataэкземпляраTabularTypeуже сопоставлен с существующим значением в базовом HashMap.
remove
CompositeData remove(Object[] key)
Удаляет CompositeData значение, индекс которого key, из этого TabularData экземпляра и возвращает удаленное значение или возвращает null , если значения с индексом key нет.
- Параметры:
-
key- индекс значения, которое нужно получить в этомTabularDataэкземпляре; должен быть допустим с определением типа строки этогоTabularDataэкземпляра; не должно быть null. - Возвращает:
- предыдущее значение, связанное с указанным ключом, или
nullесли сопоставления для ключа не было. - Исключение:
-
NullPointerException- если keynull -
InvalidKeyException- если key не соответствует определению типа строки этогоTabularDataэкземпляраTabularType
putAll
void putAll(CompositeData[] values)
Добавляет все элементы в values в этот TabularData экземпляр. Если какой-либо элемент в values не удовлетворяет ограничениям, определенным в , или если какие-либо два элемента в values имеют одинаковый индекс, рассчитанный в соответствии с определением этого putTabularData экземпляра TabularType, то выбрасывается исключение, описывающее ошибку, и ни один элемент values не добавляется, тем самым оставляя этот TabularData экземпляр неизменным.
- Параметры:
-
values- массив значений составных данных, которые необходимо добавить в качестве новых строк в этотTabularDataэкземпляр; если valuesnullили пуст, этот метод возвращается без каких-либо действий. - Исключение:
-
NullPointerException- если элемент valuesnull -
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 экземпляра.
Строковое представление состоит из имени реализуемого класса и табличного типа этого экземпляра.
© 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.