Package com.github._1c_syntax.bsl.reader

Interface MDReader

All Known Implementing Classes:
DesignerReader, EDTReader, FakeReader
public interface MDReader
Интерфейс для ридеров исходников

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    configurationExtensionFilter()
    Возвращает строку-фильтр для различия расширения и конфигурации
    @NonNull com.github._1c_syntax.bsl.types.ConfigurationSource
    getConfigurationSource()
    Возвращает тип исходных файлов ридера
    @NonNull MDCReadSettings
    getReadSettings()
    Возвращает установленные настройки чтения
    @NonNull Path
    getRootPath()
    Возвращает путь к корню читаемого контейнера
    ExtendXStream
    getXstream()
    Геттер для xstream
    @NonNull Path
    mdoTypeFolderPath(Path mdoPath)
    Определяет путь к каталогу с файлами типа объекта
    @NonNull Path
    moduleFolder(Path mdoPath, com.github._1c_syntax.bsl.types.MDOType mdoType)
    Рассчитывает каталог, в которм должны располагаться модули объекта
    @NonNull Path
    modulePath(Path folder, String name, com.github._1c_syntax.bsl.types.ModuleType moduleType)
    Определяет путь к файлу модуля объекта
    default Object
    read(String fullName)
    Выполняет чтение объекта по полному имени
    default Object
    read(Path path)
    Выполняет чтение объекта по пути к файлу
    Object
    read(Path folder, String fullName)
    Выполняет чтение объекта по каталогу файлов и имени объекта
    @NonNull MDClass
    readConfiguration()
    Выполняет чтение конфигурации
    @NonNull ExternalSource
    readExternalSource()
    Выполняет чтение внешнего отчета или внешней обработки
    FormData
    readFormData(Path currentPath, String name, com.github._1c_syntax.bsl.types.MDOType mdoType)
    Читает данные формы
    @NonNull String
    subsystemsNodeName()
    Возвращает имя поля для чтения подсистем
    void
    unmarshal(com.thoughtworks.xstream.io.HierarchicalStreamReader reader, com.thoughtworks.xstream.converters.UnmarshallingContext context, AbstractReaderContext readerContext)
    Выполняет чтение объекта из файла

  • Method Details

    • getConfigurationSource

      @NonNull @NonNull com.github._1c_syntax.bsl.types.ConfigurationSource getConfigurationSource()
      Возвращает тип исходных файлов ридера
      Returns:
      Тип исходных файлов

    • getRootPath

      @NonNull @NonNull Path getRootPath()
      Возвращает путь к корню читаемого контейнера
      Returns:
      Путь

    • getReadSettings

      @NonNull @NonNull MDCReadSettings getReadSettings()
      Возвращает установленные настройки чтения
      Returns:
      Настройки чтения

    • readConfiguration

      @NonNull @NonNull MDClass readConfiguration()
      Выполняет чтение конфигурации
      Returns:
      Прочитанная конфигурация

    • readExternalSource

      @NonNull @NonNull ExternalSource readExternalSource()
      Выполняет чтение внешнего отчета или внешней обработки
      Returns:
      Прочитанный контейнер

    • read

      @Nullable default Object read(String fullName)
      Выполняет чтение объекта по полному имени
      Parameters:
      fullName - Полное имя объекта
      Returns:
      прочитанный объект либо null, если прочитать не удалось (например не существует)

    • read

      @Nullable default Object read(Path path)
      Выполняет чтение объекта по пути к файлу
      Parameters:
      path - Путь к файлу
      Returns:
      прочитанный объект либо null, если прочитать не удалось (например не существует)

    • read

      @Nullable Object read(Path folder, String fullName)
      Выполняет чтение объекта по каталогу файлов и имени объекта
      Parameters:
      folder - Путь к каталогу файлов
      fullName - Полное имя читаемого объекта
      Returns:
      прочитанный объект либо null, если прочитать не удалось (например не существует)

    • getXstream

      ExtendXStream getXstream()
      Геттер для xstream

    • readFormData

      @Nullable FormData readFormData(Path currentPath, String name, com.github._1c_syntax.bsl.types.MDOType mdoType)
      Читает данные формы
      Parameters:
      currentPath - Путь к объекту
      name - Имя объекта
      mdoType - тип объекта
      Returns:
      Данные формы

    • moduleFolder

      @NonNull @NonNull Path moduleFolder(Path mdoPath, com.github._1c_syntax.bsl.types.MDOType mdoType)
      Рассчитывает каталог, в которм должны располагаться модули объекта
      Parameters:
      mdoPath - Путь к описанию объекта
      mdoType - Тип объекта
      Returns:
      Путь к каталогу с модулями

    • modulePath

      @NonNull @NonNull Path modulePath(Path folder, String name, com.github._1c_syntax.bsl.types.ModuleType moduleType)
      Определяет путь к файлу модуля объекта
      Parameters:
      folder - Каталог модулей
      name - Имя объекта
      moduleType - Тип модуля
      Returns:
      Путь к файлу модуля

    • mdoTypeFolderPath

      @NonNull @NonNull Path mdoTypeFolderPath(Path mdoPath)
      Определяет путь к каталогу с файлами типа объекта
      Parameters:
      mdoPath - Путь к файлу объекта
      Returns:
      Путь к каталогу типа

    • subsystemsNodeName

      @NonNull @NonNull String subsystemsNodeName()
      Возвращает имя поля для чтения подсистем
      Returns:
      Имя поля

    • configurationExtensionFilter

      @NonNull @NonNull String configurationExtensionFilter()
      Возвращает строку-фильтр для различия расширения и конфигурации
      Returns:
      Строка-фильтр

    • unmarshal

      void unmarshal(com.thoughtworks.xstream.io.HierarchicalStreamReader reader, com.thoughtworks.xstream.converters.UnmarshallingContext context, AbstractReaderContext readerContext)
      Выполняет чтение объекта из файла
      Parameters:
      reader - - Читатель Xstream
      context - - Контекст читателя Xstream
      readerContext - - Контекст читателя MDClasses