package org.springframework.core.env;

import org.springframework.core.convert.support.ConfigurableConversionService;
import org.springframework.lang.Nullable;

/**
 * 此接口是大多數(shù)PropertyResolver實(shí)現(xiàn)類的父接口，它規(guī)范了使用property的方法，
 * 并且使用戶可以定制化PropertyResolver在解析和轉(zhuǎn)換property時(shí)候的邏輯
 */
public interface ConfigurablePropertyResolver extends PropertyResolver {

    /**
     * 返回在解析屬性時(shí)使用的ConfigurableConversionService。此方法的返回值可被用戶定制化，
     * 例如可以移除或者添加Converter
     * ConfigurableConversionService cs = env.getConversionService();
     * cs.addConverter(new FooConverter());
     */
    ConfigurableConversionService getConversionService();

    /**
     * 設(shè)置在涉及到屬性轉(zhuǎn)換操作時(shí)所使用到的ConfigurableConversionService
     */
    void setConversionService(ConfigurableConversionService conversionService);

    /**
     * 設(shè)置該 resolver 所能處理的占位符的前綴
     */
    void setPlaceholderPrefix(String placeholderPrefix);

    /**
     * 設(shè)置該 resolver 所能處理的占位符的后綴
     */
    void setPlaceholderSuffix(String placeholderSuffix);

    /**
     * 指定該resolver所能替換的分隔符與其默認(rèn)值直接的分隔符，
     * 如果不存在分隔符，則傳null
     */
    void setValueSeparator(@Nullable String valueSeparator);

    /**
     * 是否忽略不可解析的嵌套占位符
     */
    void setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders);

    /**
     * 指定哪些屬性是必須屬性
     */
    void setRequiredProperties(String... requiredProperties);

    /**
     * 驗(yàn)證所有的必須屬性是否都存在，并且屬性值非null
     * 否則拋出 MissingRequiredPropertiesException
     */
    void validateRequiredProperties() throws MissingRequiredPropertiesException;

}