Skip to content

Latest commit

 

History

History
355 lines (344 loc) · 15.5 KB

README.md

File metadata and controls

355 lines (344 loc) · 15.5 KB

Описание публичного интерфейса библиотеки

Модуль Версии:

Основной модуль для работы с версиями

ВерсияИзФайла

// Выполняет чтение версии из файла
//
// Параметры:
//   ПутьКФайлуВерсии - Строка - путь к файлу с версией
//
// Возвращаемое значение:
//   Версия - класс версия

МаксимальнаяИзМассива

// Возвращает максимальную версию из массива версией
//
// Параметры:
//   МассивВерсий - Массив - Элементы массива - класс версия
//
// Возвращаемое значение:
//   Версия - класс версия

ВерсияВДиапазоне

// Выполняет проверки версии на соответствие диапазону
//
// Параметры:
//   ПроверяемаяВерсия - Строка/Класс Версия - проверяемая версия 
//   СтрокаДиапазон - Строка - Строковое представление диапазона
//
// Возвращаемое значение:
//   булево - Истина, если версия в диапазоне.

Сравнение

// Создает и возвращает сравнение версий
//
// Параметры:
//   СтрокаДиапазон - Строка - Строковое представление начального диапазона (Необязательно)
//
// Возвращаемое значение:
//   СравнениеВерсий - класс СравнениеВерсий

СтрокиВерсийВМассив

// Преобразовывает массив строк версий в массив версий
//
// Параметры:
//   МассивСтрокВерсий - Массив - элементы строка, типа "1.0.0"
//
// Возвращаемое значение:
//   МассивВерсий - массив -  элементы класс Версия

МаксимальнаяВерсияМежду

// Возвращает максимальную версию в соответствии диапазонами
//
// Параметры:
//   МассивСтрокВерсий - Массив - элементы строка, типа "1.0.0"
//   ДиапазонСнизу - Строка - Строковое представление диапазона
//   ДиапазонСверху - Строка - Строковое представление диапазона (необязательно)
//
// Возвращаемое значение:
//   Версия - класс версия

ВерсияИзСтроки

// Возвращает версию из строки
//
// Параметры:
//   СтрокаВерсии - Строка/Класс Версия - Строковое представление версии типа "1.0.0"
//
// Возвращаемое значение:
//   Версия - класс версия

СравнитьВерсии

// Выполняет сравнение версий
//
// Параметры:
//   СтрокаВерсия1 - Строка/Класс Версия - Строковое представление версии типа "1.0.0"
//   СтрокаВерсия2 - Строка/Класс Версия - Строковое представление версии типа "1.0.0"
//
// Возвращаемое значение:
//   Число - результат сравнения в числе (0 = Равны, -1 = Меньше, 1 = Больше), относительно первой версии (СтрокаВерсия1)
// Пример, 
//  (-1) - СтрокаВерсия1 меньше (<) СтрокаВерсия2
//  (1) - СтрокаВерсия1 больше (>) СтрокаВерсия2
//  (0) - СтрокаВерсия1 равна (=) СтрокаВерсия2

Класс СравнениеВерсий:

Класс для работы в форме fluent с сравнениями версий

ДобавитьДиапазон

// Добавляет диапазон в сравнение
//
// Параметры:
//   СтрокаДиапазона - Строка - строковое представление диапазона
// Возвращаемое значение:
//   ЭтотОбъект - класс СравнениеВерсий

ПроверяемыеВерсии

// Добавляет массив версий в сравнение и возвращает себя
//
// Параметры:
//   СтрокаДиапазона - Массив - Элементы <Строка> или класс <Версия> проверяемых версий
//   ОчищатьМассив - булево - признак очистки предыдущего набора версий
// Возвращаемое значение:
//   ЭтотОбъект - класс СравнениеВерсий

ПроверяемаяВерсия

// Добавляет версию в сравнение и возвращает себя
//
// Параметры:
//   ВходящаяВерсия - Строка/Класс_Версия - Версия для сравнения с диапазоном
//   ОчищатьМассив - булево - признак очистки предыдущего набора версий
// Возвращаемое значение:
//   ЭтотОбъект - класс СравнениеВерсий

Сравнить

// Выполняет сравнение и возвращает себя
//
// Возвращаемое значение:
//   ЭтотОбъект - класс СравнениеВерсий

ВМассив

// Выполняет сравнение и выгружает результат в массив
//
// Возвращаемое значение:
//   Массив - массив элементов класса версия

ВМассивСтрок

// Выполняет сравнение и выгружает результат в массив строк версий
//
// Возвращаемое значение:
//   Массив - массив элементов строка  (вызов Версия.ВСтроку())

ВДиапазоне

// Выполняет сравнение и проверяет, что все элементы, присутствуют в массиве после сравнения
//
// Возвращаемое значение:
//   Булево - все элементы есть в массиве

Максимальная

// Выполняет сравнение и возвращает максимальную версию из результата
//
// Возвращаемое значение:
//   Версия - элемент класса версия

Сброс

// Выполняет сброс версий, результата сравнения и возвращает себя
// НЕ СБРАСЫВАЕТ ДИАПАЗОН ВЕРСИЙ
//
// Возвращаемое значение:
//   ЭтотОбъект - класс СравнениеВерсий

Класс ДиапазонВерсий:

Класс для работы с диапазонами версий и их чтение из строки

ПроверитьВерсию

// Выполняет проверку, что версия удовлетворяет диапазону
//
// Возвращаемое значение:
//   Булево - Истина / ложь

ПолучитьСравнение

// Возвращает сравнение для диапазона версий
//
// Возвращаемое значение:
//   Соответствие 
//      ключ     - символ действия (>=. <=, =, >, <)
//      Значение - класс версия

ПроверитьВерсии

// Выполняет проверку массива версий, на соответствие диапазону
//
// Параметры:
//   МассивВерсий - элементы класса версия - Версия для сравнения с диапазоном
//
// Возвращаемое значение:
//   Массив - элементы класса версия

МаксимальнаяВерсияИЗВерсий

// Выполняет проверку массива версий, на соответствие диапазону
// И возвращает максимальную из них 
//
// Параметры:
//   МассивВерсий - элементы класса версия - Версия для сравнения с диапазоном
//
// Возвращаемое значение:
//   Версия - класс версия, максимальный из проверяемого массива

ВСтроку

// Возвращает строковое представление диапазона версий
//
// Возвращаемое значение:
//   строка - строковое представление (типа: >=1.0.0 - < 2.0.0)

ОбъединитьСДиапазоном

// Объединяет с переданным диапазоном
//
// Параметры:
//   ВходящийДиапазон - класс ДиапазонВерсий - объединяемый диапазон

Класс Версия:

Класс для работы с версиями и их чтение из строки

Ошибка

// Возвращает наличие ошибки при чтении версии
//
// Возвращаемое значение:
//   булево - истина / ложь

ПолучитьОписаниеОшибки

// Возвращает описание ошибки при чтении версии
//
// Возвращаемое значение:
//   строка - подробное описание чтения версии из строки

ВСтроку

// Возвращает строковое представление версии
//
// Возвращаемое значение:
//   строка - строковое представление версии (типа: 1.0.0, 2.0.0)

Сравнить

// Выполняет сравнение версии с входящей версией
//
// Параметры:
//   ВходящаяВерсия - Класс Версия - версия для сравнения
// Возвращаемое значение:
//   Число - результат сравнения в числе (0 = Равны, -1 = Меньше, 1 = Больше), относительно входящей версии

Равны

// Проверяет равенство версии с входящей версией
//
// Параметры:
//   ВходящаяВерсия - Класс Версия - версия для сравнения
// Возвращаемое значение:
//   Булево - истина / ложь

НеРавны

// Проверяет не равенство версии с входящей версией
//
// Параметры:
//   ВходящаяВерсия - Класс Версия - версия для сравнения
// Возвращаемое значение:
//   Булево - истина / ложь

Меньше

// Проверяет, что текущая версия меньше входящей версии
//
// Параметры:
//   ВходящаяВерсия - Класс Версия - версия для сравнения
// Возвращаемое значение:
//   Булево - истина / ложь

МеньшеИлиРавны

// Проверяет, что текущая версия меньше или равна входящей версии
//
// Параметры:
//   ВходящаяВерсия - Класс Версия - версия для сравнения
// Возвращаемое значение:
//   Булево - истина / ложь

Больше

// Проверяет, что текущая версия больше входящей версии
//
// Параметры:
//   ВходящаяВерсия - Класс Версия - версия для сравнения
// Возвращаемое значение:
//   Булево - истина / ложь

БольшеИлиРавны

// Проверяет, что текущая версия больше или равна входящей версии
//
// Параметры:
//   ВходящаяВерсия - Класс Версия - версия для сравнения
// Возвращаемое значение:
//   Булево - истина / ложь