ru.crystals.pos.spi

Interface PropertiesReader

public interface PropertiesReader

Интерфейс для чтения настроек .

Поскольку параметры могут быть изменены централизованно в любой момент времени, не рекомендуется хранить копии их значений в классе плагина.

Рекомендуется:

 @POSPlugin(id = "foo.plugin")
 public class FooPlugin implements PaymentPlugin {
 
     @Inject
     private IntegrationProperties properties;
 
     @Override
     public void doPayment(PaymentRequest request) {
         String ip = properties.getServiceProperties().get("processing.ip");
         // do something
     }
 
 }
 

Не рекомендуется:

 @POSPlugin(id = "foo.plugin")
 public class FooPlugin implements PaymentPlugin {
 
     @Inject
     private IntegrationProperties properties;
 
     private String ip = null;
 
     @Override
     public void doPayment(PaymentRequest request) {
         if (ip == null) {
             String ip = properties.getServiceProperties().get("processing.ip");
         }
         // do something
     }
 
 }
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String key) Чтение символьного параметра.
java.lang.String	get(java.lang.String key, java.lang.String defaultValue) Чтение символьного параметра.
java.util.Map<java.lang.String,java.lang.String>	getAllProperties() Получить все настройки.
boolean	getBoolean(java.lang.String key) Чтение логического параметра.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Чтение логического параметра.
byte[]	getBytes(java.lang.String key) Чтение параметра, как массива байтов.
java.math.BigDecimal	getDecimal(java.lang.String key) Возвращает из настроек значение как BigDecimal параметра с указанным идентификатором.
java.math.BigDecimal	getDecimal(java.lang.String key, java.math.BigDecimal defaultValue) Возвращает из настроек значение как BigDecimal параметра с указанным идентификатором.
java.lang.Integer	getInt(java.lang.String key) Чтение целочисленного параметра.
int	getInt(java.lang.String key, int defaultValue) Чтение целочисленного параметра.
void	set(java.lang.String key, java.lang.String value) Запись символьного параметра.
void	setAllProperties(java.util.Map<java.lang.String,java.lang.String> properties) Сохранить настройки.
void	setBoolean(java.lang.String key, java.lang.Boolean value) Запись логического параметра.
void	setBytes(java.lang.String key, byte[] value) Запись параметра как массива байтов.
void	setDecimal(java.lang.String key, java.math.BigDecimal value) Сохраняет значение параметра как BigDecimal.
void	setInt(java.lang.String key, java.lang.Integer value) Запись целочисленного параметра.

Method Detail

getAllProperties

java.util.Map<java.lang.String,java.lang.String> getAllProperties()

Получить все настройки.

Returns:

Коллекция всех имеющихся настроек.

get

java.lang.String get(java.lang.String key)

Чтение символьного параметра.

Parameters:

key - ключ параметра

Returns:

Значение параметра, null если параметр отсутствует

get

java.lang.String get(java.lang.String key,
                     java.lang.String defaultValue)

Чтение символьного параметра.

Parameters:

key - ключ параметра

defaultValue - значение по умолчанию

Returns:

Значение параметра, если он указан, иначе defaultValue

getInt

java.lang.Integer getInt(java.lang.String key)

Чтение целочисленного параметра.

Parameters:

key - ключ параметра

Returns:

Значение параметра, null если параметр отсутствует

getInt

int getInt(java.lang.String key,
           int defaultValue)

Чтение целочисленного параметра.

Parameters:

key - ключ параметра

defaultValue - значение по умолчанию

Returns:

Значение параметра, если он указан, иначе defaultValue

getBytes

byte[] getBytes(java.lang.String key)

Чтение параметра, как массива байтов.

Parameters:

key - ключ параметра

Returns:

массив байтов, null если параметр отсутствует

getBoolean

boolean getBoolean(java.lang.String key)

Чтение логического параметра.

Parameters:

key - ключ параметра

Returns:

Значение параметра, если он указан, иначе false

getBoolean

boolean getBoolean(java.lang.String key,
                   boolean defaultValue)

Чтение логического параметра.

Parameters:

key - ключ параметра

defaultValue - значение по умолчанию

Returns:

Значение параметра, если он указан, иначе false

getDecimal

java.math.BigDecimal getDecimal(java.lang.String key)

Возвращает из настроек значение как BigDecimal параметра с указанным идентификатором.

Parameters:

key - идентификатор параметра, значение которого требуется прочитать как BigDecimal.

Returns:

значение параметра в BigDecimal или null, если такого нет или значение его не может быть приведено к данному типу.

Since:

0.0.35

getDecimal

java.math.BigDecimal getDecimal(java.lang.String key,
                                java.math.BigDecimal defaultValue)

Возвращает из настроек значение как BigDecimal параметра с указанным идентификатором.

Parameters:

key - идентификатор параметра, значение которого требуется прочитать как BigDecimal.

defaultValue - значение параметра по умолчанию на случай, если его значение не задано или не может быть приведено к BigDecimal

Returns:

значение параметра в BigDecimal или значение аргумента defaultValue, если значение параметра не задано или не может быть приведено к данному типу.

Since:

0.0.35

setAllProperties

void setAllProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Сохранить настройки.

Parameters:

properties - коллекция настроек для сохранения.

set

void set(java.lang.String key,
         java.lang.String value)

Запись символьного параметра.

Parameters:

key - ключ параметра

value - значение параметра

setInt

void setInt(java.lang.String key,
            java.lang.Integer value)

Запись целочисленного параметра.

Parameters:

key - ключ параметра

value - значение параметра

setBytes

void setBytes(java.lang.String key,
              byte[] value)

Запись параметра как массива байтов.

Parameters:

key - ключ параметра

value - значение параметра

setBoolean

void setBoolean(java.lang.String key,
                java.lang.Boolean value)

Запись логического параметра.

Parameters:

key - ключ параметра

value - значение параметра

setDecimal

void setDecimal(java.lang.String key,
                java.math.BigDecimal value)

Сохраняет значение параметра как BigDecimal.

Parameters:

key - идентификатор параметра.

value - значение параметра.