Класс ImmutableDescriptor

public static final ImmutableDescriptor EMPTY_DESCRIPTOR

public ImmutableDescriptor(String[] fieldNames, Object[] fieldValues)

Параметры:

fieldNames - имена полей

fieldValues - значения полей

Исключения:

IllegalArgumentException - если любой из массивов равен null, или если массивы имеют разные размеры, или если имя поля равно null или пустое, или если одно и то же имя поля встречается более одного раза.

public ImmutableDescriptor(String... fields)

Параметры:

fields - имена полей

Исключения:

IllegalArgumentException - если параметр равен null, или если имя поля пустое, или если одно и то же имя поля встречается более одного раза, или если одна из строк не содержит символа =.

public ImmutableDescriptor(Map<String,?> fields)

Параметры:

fields - имена и значения полей

Исключения:

IllegalArgumentException - если параметр равен null, или если имя поля равно null или пустое, или если одно и то же имя поля встречается более одного раза (что может произойти из-за того, что имена полей не чувствительны к регистру).

public static ImmutableDescriptor union(Descriptor... descriptors)

 Descriptor d = something();
 ImmutableDescriptor copy = ImmutableDescriptor.union(d);
 

Параметры:

descriptors - объединяемые дескрипторы. Любой из дескрипторов может быть null, в этом случае он пропускается.

Возвращает:

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

Исключения:

IllegalArgumentException - если два дескриптора содержат одно и то же имя поля с разными связанными значениями. Массивы примитивных типов считаются одинаковыми, если они имеют одинаковый тип и одинаковые элементы. Массивы объектов считаются одинаковыми, если Arrays.deepEquals(Object[],Object[]) возвращает true.

public final Object getFieldValue(String fieldName)

Унаследованно от:

getFieldValue в интерфейсе Descriptor

Параметры:

fieldName - имя поля.

Возвращает:

соответствующее значение или null, если поле отсутствует.

public final String[] getFields()

Унаследованно от:

getFields в интерфейсе Descriptor

Возвращает:

Массив строк полей в формате имяПоля=значениеПоля
Если значение поля не является строкой, то вызывается метод toString() для него, а возвращённое значение, заключённое в скобки, используется в качестве значения поля в возвращаемом массиве. Если значение поля равно null, то значение поля в возвращаемом массиве будет пустым. Если дескриптор пуст, то возвращается пустой массив.

См. также:

• Descriptor.setFields(java.lang.String[], java.lang.Object[])

public final Object[] getFieldValues(String... fieldNames)

Унаследованно от:

getFieldValues в интерфейсе Descriptor

Параметры:

fieldNames - Массив строк с именами полей, для которых должны быть возвращены значения. Если массив пустой, возвращается пустой массив. Если массив равен null, возвращаются все значения, как если бы параметром был массив, возвращаемый Descriptor.getFieldNames(). Если имя поля в массиве не существует, включая случай, когда оно равно null или пустой строке, то в соответствующий элемент возвращаемого массива помещается null.

Возвращает:

массив объектов значений полей. Если список fieldNames пустой, возвращается пустой массив.

public final String[] getFieldNames()

Унаследованно от:

getFieldNames в интерфейсе Descriptor

Возвращает:

массив строк имён полей. Если дескриптор пуст, возвращается пустой массив.

public boolean equals(Object o)

Унаследованно от:

equals в интерфейсе Descriptor

Переопределяет:

equals в классе Object

Параметры:

o - сравниваемый объект.

Возвращает:

true, если объекты одинаковы; false в противном случае.

См. также:

• Object.hashCode()
• HashMap

public int hashCode()

Унаследованно от:

hashCode в интерфейсе Descriptor

Переопределяет:

hashCode в классе Object

Возвращает:

Хэш-код этого объекта.

См. также:

• Object.equals(java.lang.Object)
• System.identityHashCode(java.lang.Object)

public boolean isValid()

Определено в:

isValid в интерфейсе Descriptor

Возвращает:

true, если значения допустимы.

Исключения:

RuntimeOperationsException - если проверка на валидность завершилась неудачно. Метод возвращает false, если дескриптор не валиден, но выбрасывает это исключение, если попытка определить валидность завершилась неудачно.

public Descriptor clone()

Определено в:

clone в интерфейсе Descriptor

Переопределяет:

clone в классе Object

Возвращает:

Дескриптор, равный этому дескриптору.

Исключения:

RuntimeOperationsException - для недопустимого значения для поля Имена или поля Значения. Если создание дескриптора завершится неудачно по какой-либо причине, это исключение будет выброшено.

См. также:

• Cloneable

public final void setFields(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException

Определено в:

setFields в интерфейсе Descriptor

Параметры:

fieldNames - Массив строк имён полей. Массив и элементы массива не могут быть null.

fieldValues - Массив объектов соответствующих значений полей. Массив не может быть null. Элементы массива могут быть null.

Исключения:

RuntimeOperationsException - если изменение завершится неудачно по любой причине. Обернутое исключение - IllegalArgumentException, если fieldNames или fieldValues равно null, или если массивы имеют разную длину, или если есть недопустимое значение в одном из них. Обернутое исключение - UnsupportedOperationException, если дескриптор неизменяемый, и вызов изменит его содержимое.

См. также:

• Descriptor.getFields()

public final void setField(String fieldName, Object fieldValue) throws RuntimeOperationsException

Определено в:

setField в интерфейсе Descriptor

Параметры:

fieldName - Имя поля, которое нужно установить. Не может быть null или пустым.

fieldValue - Значение поля, которое нужно установить для имени поля. Может быть null, если это допустимое значение для поля.

Исключения:

RuntimeOperationsException - если имя поля или значение поля недопустимы (обернутое исключение - IllegalArgumentException); или если дескриптор неизменяемый (обернутое исключение - UnsupportedOperationException).

public final void removeField(String fieldName)

Определено в:

removeField в интерфейсе Descriptor

Параметры:

fieldName - Строковое имя поля, которое нужно удалить. Если имя поля недопустимо или поле не найдено, исключение не выбрасывается.

Исключения:

RuntimeOperationsException - если поле с заданным именем существует и дескриптор неизменяемый. Обернутое исключение будет UnsupportedOperationException.