Skip to content

Commit 898986a

Browse files
committed
Обновлены комментарии в классах Catalog и CodeSeries для улучшения понимания свойств checkUnique и codeSeries. Добавлены пояснения о значении и области действия уникальности кода справочника.
1 parent 4e25dab commit 898986a

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

src/main/java/com/github/_1c_syntax/bsl/mdo/Catalog.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,19 @@ public class Catalog implements ReferenceObject, AccessRightsOwner {
116116
List<MdoReference> owners;
117117

118118
/**
119-
* Проверять уникальность кода справочника
119+
* Проверять уникальность кода справочника.
120+
* Определяет, нужно ли проверять уникальность кода справочника.
121+
* Если значение равно true, то код справочника должен быть уникальным в пределах области,
122+
* определяемой свойством {@link #codeSeries}.
120123
*/
121124
@Default
122125
boolean checkUnique = true;
123126

124127
/**
125-
* Серия кодов справочника
128+
* Серия кодов справочника.
129+
* Определяет область действия уникальности кода справочника.
130+
* Значение по умолчанию: {@link CodeSeries#WHOLE_CATALOG}.
131+
* Для формата EDT: если поле отсутствует, автоматически устанавливается значение WHOLE_CATALOG.
126132
*/
127133
@Default
128134
CodeSeries codeSeries = CodeSeries.WHOLE_CATALOG;

src/main/java/com/github/_1c_syntax/bsl/mdo/support/CodeSeries.java

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,46 @@
3232
import lombok.experimental.Accessors;
3333

3434
/**
35-
* Серия кодов справочника
35+
* Серия кодов справочника.
36+
* Определяет область действия уникальности кода справочника.
3637
*/
3738
@ToString(of = "fullName")
3839
public enum CodeSeries implements EnumWithName {
40+
/**
41+
* Весь справочник - уникальность кода проверяется во всем справочнике
42+
*/
3943
WHOLE_CATALOG("WholeCatalog", "ВесьСправочник"),
44+
/**
45+
* В пределах подчинения - уникальность кода проверяется в пределах подчинения
46+
*/
4047
WITHIN_SUBORDINATION("WithinSubordination", "ВПределахПодчинения"),
48+
/**
49+
* В пределах подчинения владельцу - уникальность кода проверяется в пределах подчинения владельцу
50+
*/
4151
WITHIN_OWNER_SUBORDINATION("WithinOwnerSubordination", "ВПределахПодчиненияВладельцу");
4252

4353
private static final Map<String, CodeSeries> KEYS = EnumWithName.computeKeys(values());
4454

55+
/**
56+
* Полное имя элемента перечисления (на русском и английском языках)
57+
*/
4558
@Getter
4659
@Accessors(fluent = true)
4760
private final MultiName fullName;
4861

62+
/**
63+
* Конструктор элемента перечисления
64+
*
65+
* @param nameEn Английское имя элемента
66+
* @param nameRu Русское имя элемента
67+
*/
4968
CodeSeries(String nameEn, String nameRu) {
5069
this.fullName = MultiName.create(nameEn, nameRu);
5170
}
5271

5372
/**
54-
* Ищет элемент перечисления по именам (рус, анг)
73+
* Ищет элемент перечисления по именам (рус, анг).
74+
* Поиск выполняется без учета регистра.
5575
*
5676
* @param string Имя искомого элемента
5777
* @return Найденное значение, если не найден - то WHOLE_CATALOG

0 commit comments

Comments
 (0)