org.yelong.support.yaml.YamlProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yelong-support Show documentation

对各种开源框架的包装、支持、拓展。这里也包含的yelong-core与orm框架的整合。默认对所有依赖为 scope 为 provided 。您需要针对自己的需要进行再次依赖

There is a newer version: 2.2.0

/**
 * 
 */
package org.yelong.support.yaml;

import java.util.Collection;
import java.util.Map;

import org.yelong.core.annotation.Nullable;

/**
 * yml配置文件
 * 
 * @author PengFei
 */
public interface YamlProperties {

	/**
	 * 获取属性值
	 * 
	 * @param key yml key 如：server.port
	 * @return 键对应的值
	 */
	@Nullable
	String getProperty(String key);
	
	/**
	 * 获取属性值
	 * 
	 * @param key key
	 * @param defaultValue 默认值
	 * @return 如果key值不存在则返回defaultValue，否则返回对应值
	 */
	String getProperty(String key,String defaultValue);
	
	/**
	 * 将配置装配为对象
	 * 
	 * @param  class type
	 * @param prefix 前缀
	 * @param type 类型
	 * @return 装配的对象
	 */
	 T as(String prefix,Class type);
	
	/**
	 * 获取源映射
	 * 
	 * @return yaml直接转换的map
	 */
	Map getSourceMap();
	
	/**
	 * @return 源映射全部转换为键值对的映射
	 */
	Map getMap();
	
	/**
	 * @return 所有的键值
	 */
	Collection getKeys();
	
	/**
	 * @return yaml文件名称
	 */
	@Nullable
	String getName();
	
}