Skip to content

Commit b09c113

Browse files
committed
feat: Добавлены комментарии и документация в RoleConverter для улучшения понимания кода
- Добавлены Javadoc комментарии для методов и класса, описывающие их функциональность и параметры. - Обновлены пути к файлам прав доступа.
1 parent f7cf5ec commit b09c113

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

src/main/java/com/github/_1c_syntax/bsl/reader/designer/converter/RoleConverter.java

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,21 @@
3131
import java.nio.file.Path;
3232
import java.nio.file.Paths;
3333

34+
/**
35+
* Конвертер для чтения ролей из формата конфигуратора
36+
*/
3437
@DesignerConverter
3538
public class RoleConverter extends AbstractReadConverter {
3639

3740
private static final String DATA_FIELD = "data";
3841

42+
/**
43+
* Выполняет чтение роли из XML, включая данные прав доступа из файла Rights.xml
44+
*
45+
* @param reader Ридер XML потока
46+
* @param context Контекст десериализации
47+
* @return Прочитанный объект роли с данными прав доступа
48+
*/
3949
@Override
4050
public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
4151
var readerContext = super.read(reader, context);
@@ -57,11 +67,24 @@ public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext co
5767
return readerContext.build();
5868
}
5969

70+
/**
71+
* Проверяет, может ли конвертер обработать указанный тип
72+
*
73+
* @param type Тип класса для проверки
74+
* @return true, если тип является Role или его подклассом
75+
*/
6076
@Override
6177
public boolean canConvert(Class type) {
6278
return Role.class.isAssignableFrom(type);
6379
}
6480

81+
/**
82+
* Формирует путь к файлу Rights.xml для роли
83+
*
84+
* @param path Путь к файлу описания роли
85+
* @param name Имя роли
86+
* @return Путь к файлу Rights.xml
87+
*/
6588
private static Path dataPath(Path path, String name) {
6689
return Paths.get(path.getParent().toString(), name, "Ext", "Rights.xml");
6790
}

src/main/java/com/github/_1c_syntax/bsl/reader/edt/converter/RoleConverter.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,21 @@
3030

3131
import java.nio.file.Path;
3232

33+
/**
34+
* Конвертер для чтения ролей из формата ЕДТ
35+
*/
3336
@EDTConverter
3437
public class RoleConverter extends AbstractReadConverter {
3538

3639
private static final String DATA_FIELD = "data";
3740

41+
/**
42+
* Выполняет чтение роли из XML, включая данные прав доступа из файла Rights.rights
43+
*
44+
* @param reader Ридер XML потока
45+
* @param context Контекст десериализации
46+
* @return Прочитанный объект роли с данными прав доступа
47+
*/
3848
@Override
3949
public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
4050
var readerContext = super.read(reader, context);
@@ -56,11 +66,23 @@ public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext co
5666
return readerContext.build();
5767
}
5868

69+
/**
70+
* Проверяет, может ли конвертер обработать указанный тип
71+
*
72+
* @param type Тип класса для проверки
73+
* @return true, если тип является Role или его подклассом
74+
*/
5975
@Override
6076
public boolean canConvert(Class type) {
6177
return Role.class.isAssignableFrom(type);
6278
}
6379

80+
/**
81+
* Формирует путь к файлу Rights.rights для роли
82+
*
83+
* @param path Путь к файлу описания роли
84+
* @return Путь к файлу Rights.rights
85+
*/
6486
private static Path dataPath(Path path) {
6587
return Path.of(path.getParent().toString(), "Rights.rights");
6688
}

0 commit comments

Comments
 (0)