Class Brick

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    Application, Avalanche, Locale, Parameter, Publish, Threshold

    public abstract class Brick
    extends Object
    implements Serializable
    Базовый класс (кирпич), определяет общие свойства всех элементов, из которых строиться приложение по модели MVFA
    Since:
    JDK 1.7
    Version:
    1.00, 08 ноября. 2016 г.
    Author:
    Валерий Лиховских
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ADD
      Префикс имени методов для установки экземпляров классов дочерних элементов конфигурации.
      static String ALIASES
      Имя пакета, в котором производится поиск класса по имени тега.
      static String CLASS
      Имя атрибута элемента конфигурации, в котором определяется имя класса или алиас имени класса
      static String DATA
      Имя набора данных, передаваемых по HTTP
      static String DESCRIPTION
      Имя атрибута элемента конфигурации, в котором содержится описание (комментарий) элемента
      static String DOC
      Имя атрибута элемента конфигурации, в котором содержится корневая ссылка на раздел документации API c описанием реализации класса
      static String EXT
      Имя файлов атрибута элемента конфигурации, в котором содержится расширение файлов раздела документации API c описанием реализации класса.
      org.apache.logging.log4j.Logger logger
      Экземпляр логгирования событий
      static String LOGGER
      Имя атрибута элемента конфигурации, который определяет имя используемого логгера
      static String NAME
      Имя атрибута элемента конфигурации, в котором определяется имя элемента
      static String ROOT
      Значение атрибута LOGGER при определении корнего логгера.
      static String SET
      Префикс имени методов для установки значений атрибутов конфигурации.
      static String VALUE_OF  
    • Constructor Summary

      Constructors 
      Constructor Description
      Brick()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void done()
      Завершение выполнения экземпляра класса (элемента приложения).
      String error​(String code, Object... parameters)
      Вывести сообщение об ошибке в логгер
      String error​(Throwable throwable, String code, Object... parameters)
      Вывести сообщение об ошибке в логгер
      String errorLang​(String code, String lang, Object... parameters)
      Вывести сообщение об ошибке в логгер в заданной локализации
      String errorLang​(Throwable throwable, String code, String lang, Object... parameters)
      Вывести сообщение об ошибке в логгер в заданной локализации
      String getAliases()
      Получить имя пакета, в котором производиться поиск классов по алиасам имен тегов дочерних элементов конфигурации
      String getDescription()
      Получить описание элемента конфигурации.
      String getDoc()
      Ссылка на документацию класса.
      String getExt()
      Расширение файлов документации (пока не используется)
      String getName()
      Получить имя элемента конфигурации
      String getNodeAttribute​(String name)
      Получить значение атрибута по его имени элемента конфигурации
      String info​(String code, Object... parameters)
      Вывести информационное сообщение в логгер
      String infoLang​(String code, String lang, Object... parameters)
      Вывести информационное сообщение в логгер в указанной локализации
      abstract void init()
      Инициализация экземпляра класса (элемента приложения).
      void setAliases​(String aliases)
      Установить имя пакетов поиска классов по алиасам имен тегов дочерних элементов
      void setDescription​(String description)
      Установить описание элемента конфигурации.
      void setDoc​(String doc)
      Установить ссылку на документацию класса.
      void setExt​(String ext)
      Установить расширение файлов документации (пока не используется)
      void setLogger​(String name)
      Установить логгер экземпляра класса.
      void setName​(String name)
      Установить имя элемента конфигурации
      void setNode​(Node node)
      Установить узел конфигурации
      void setTextContent​(String content)
      Установить содержимое контекста элемента конфигурации.
      boolean toBoolean​(String value)
      Преобразует строковое значение в значение true или false.
      String toUpperFirstChar​(String name)
      Преобразовать алиас имени класса (тег XML) в имя класса (первый символ в верхнем регистре).
      String warn​(String code, Object... parameters)
      Вывести предупреждение в логгер
      String warnLang​(String code, String lang, Object... parameters)
      Вывести предупреждение в логгер в указанной локализации
    • Field Detail

      • CLASS

        public static final String CLASS
        Имя атрибута элемента конфигурации, в котором определяется имя класса или алиас имени класса
        See Also:
        Constant Field Values
      • NAME

        public static final String NAME
        Имя атрибута элемента конфигурации, в котором определяется имя элемента
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final String DESCRIPTION
        Имя атрибута элемента конфигурации, в котором содержится описание (комментарий) элемента
        See Also:
        Constant Field Values
      • DOC

        public static final String DOC
        Имя атрибута элемента конфигурации, в котором содержится корневая ссылка на раздел документации API c описанием реализации класса
        See Also:
        Constant Field Values
      • LOGGER

        public static final String LOGGER
        Имя атрибута элемента конфигурации, который определяет имя используемого логгера
        See Also:
        Constant Field Values
      • ROOT

        public static final String ROOT
        Значение атрибута LOGGER при определении корнего логгера. Если родительский элемент имеет установленное значение атрибута LOGGER, то при необходимости определения корневого логгера в этом элементе необходимо использовать это имя.
        See Also:
        Constant Field Values
      • EXT

        public static final String EXT
        Имя файлов атрибута элемента конфигурации, в котором содержится расширение файлов раздела документации API c описанием реализации класса. Например: HTML, HTM, XHTML.
        See Also:
        Constant Field Values
      • ADD

        public static final String ADD
        Префикс имени методов для установки экземпляров классов дочерних элементов конфигурации.
        See Also:
        Constant Field Values
      • SET

        public static final String SET
        Префикс имени методов для установки значений атрибутов конфигурации.
        See Also:
        Constant Field Values
      • DATA

        public static final String DATA
        Имя набора данных, передаваемых по HTTP
        See Also:
        Constant Field Values
      • ALIASES

        public static final String ALIASES
        Имя пакета, в котором производится поиск класса по имени тега. Первый символ имени тега преобразуется в верхний регистр. Имени алиаса и имени тега образуют имя класса.
        See Also:
        Constant Field Values
      • logger

        public org.apache.logging.log4j.Logger logger
        Экземпляр логгирования событий
    • Constructor Detail

      • Brick

        public Brick()
    • Method Detail

      • getName

        public String getName()
        Получить имя элемента конфигурации
        Returns:
        имя элемента конфигурации
      • setName

        public void setName​(String name)
        Установить имя элемента конфигурации
        Parameters:
        name - имя элемента конфигурации
      • getDescription

        public String getDescription()
        Получить описание элемента конфигурации. Этот атрибут конфигурации предназначен для повышения читаемости конфигурации приложения
        Returns:
        описание элемента конфигурации
      • setDescription

        public void setDescription​(String description)
        Установить описание элемента конфигурации. Этот атрибут конфигурации предназначен для повышения читаемости конфигурации приложения
      • getDoc

        public String getDoc()
        Ссылка на документацию класса. Этот атрибут конфигурации предназначен для повышения документированности конфигурации приложения
        Returns:
        ссылка на документацию класса
      • setDoc

        public void setDoc​(String doc)
        Установить ссылку на документацию класса. Этот атрибут конфигурации предназначен для повышения документированности конфигурации приложения
      • getAliases

        public String getAliases()
        Получить имя пакета, в котором производиться поиск классов по алиасам имен тегов дочерних элементов конфигурации
        Returns:
        имя пакета
      • setAliases

        public void setAliases​(String aliases)
        Установить имя пакетов поиска классов по алиасам имен тегов дочерних элементов
        Parameters:
        aliases - имя пакета
      • getExt

        public String getExt()
        Расширение файлов документации (пока не используется)
        Returns:
        расширение файлов документации
      • setExt

        public void setExt​(String ext)
        Установить расширение файлов документации (пока не используется)
      • setLogger

        @CfgAttribute(description="\u0418\u043c\u044f \u043b\u043e\u0433\u0433\u043e\u0440\u0435")
        public void setLogger​(String name)
        Установить логгер экземпляра класса. Если логгер будет найден, то будет переопределен корневой логгер, который устанавливается по умолчанию.
        Parameters:
        name - имя логгера
      • setNode

        public void setNode​(Node node)
        Установить узел конфигурации
        Parameters:
        node - узел конфигурации
      • setTextContent

        public void setTextContent​(String content)
        Установить содержимое контекста элемента конфигурации. Этот метод не имеет реализации и должен быть переопределен в дочерних классах, в которых требуется использовать контекст конфигурации.
        Parameters:
        content - контекс конфигурации
        See Also:
        Parameter
      • toUpperFirstChar

        public String toUpperFirstChar​(String name)
        Преобразовать алиас имени класса (тег XML) в имя класса (первый символ в верхнем регистре). Например: parameter преобразуется в Parameter.
        Parameters:
        name - алиас имени класса (тег XML)
        Returns:
        преобразованное имя класса
      • toBoolean

        public boolean toBoolean​(String value)
        Преобразует строковое значение в значение true или false. Полученное значение, если оно не равно null, сперва приводится к нижнему регистру.
        Parameters:
        value - строковое значения, которое преобразуется в тип boolean
        Returns:
        true, если значения эквивалентно "1", "yes" или "true", иначе возвращается false
      • init

        public abstract void init()
        Инициализация экземпляра класса (элемента приложения). В этот метод есть возможность передать произвольный массив параметров.
      • done

        public abstract void done()
        Завершение выполнения экземпляра класса (элемента приложения). Как правило, в этом методе выполняются действия по освобождению захваченных ресурсов.
      • getNodeAttribute

        public String getNodeAttribute​(String name)
        Получить значение атрибута по его имени элемента конфигурации
        Parameters:
        name - имя атрибута элемента конфигурации
        Returns:
        значение атрибута или (null, если атрибут не установлен
      • info

        public String info​(String code,
                           Object... parameters)
        Вывести информационное сообщение в логгер
        Parameters:
        code - код сообщения
        parameters - подставляемые параметры сообщения
        Returns:
        информационное сообщение
      • infoLang

        public String infoLang​(String code,
                               String lang,
                               Object... parameters)
        Вывести информационное сообщение в логгер в указанной локализации
        Parameters:
        code - код сообщения
        lang - символьное обозначение локализации сообщения. Пример: ru, en
        parameters - подставляемые параметры сообщения
        Returns:
        информационное сообщение
      • warn

        public String warn​(String code,
                           Object... parameters)
        Вывести предупреждение в логгер
        Parameters:
        code - код предупреждения
        parameters - подставляемые параметры сообщения
        Returns:
        информационное сообщение
      • warnLang

        public String warnLang​(String code,
                               String lang,
                               Object... parameters)
        Вывести предупреждение в логгер в указанной локализации
        Parameters:
        code - код предупреждение
        lang - символьное обозначение локализации сообщения. Пример: ru, en
        parameters - подставляемые параметры сообщения
        Returns:
        информационное сообщение
      • error

        public String error​(String code,
                            Object... parameters)
        Вывести сообщение об ошибке в логгер
        Parameters:
        code - код сообщения об ошибке
        parameters - подставляемые параметры в сообщение об ошибке
        Returns:
        сообщение об ошибке
      • errorLang

        public String errorLang​(String code,
                                String lang,
                                Object... parameters)
        Вывести сообщение об ошибке в логгер в заданной локализации
        Parameters:
        code - код сообщения об ошибке
        lang - символьное обозначение локализации сообщения. Пример: ru, en
        parameters - подставляемые параметры в сообщение об ошибке
        Returns:
        сообщение об ошибке
      • error

        public String error​(Throwable throwable,
                            String code,
                            Object... parameters)
        Вывести сообщение об ошибке в логгер
        Parameters:
        throwable - возникшее исключение
        code - код ошибки
        parameters - подставляемые параметры в сообщение об ошибке
        Returns:
        сообщение об ошибке
      • errorLang

        public String errorLang​(Throwable throwable,
                                String code,
                                String lang,
                                Object... parameters)
        Вывести сообщение об ошибке в логгер в заданной локализации
        Parameters:
        throwable - возникшее исключение
        code - код ошибки
        lang - символьное обозначение локализации сообщения. Пример: ru, en
        parameters - подставляемые параметры в сообщение об ошибке
        Returns:
        сообщение об ошибке