EgovPropertyService.java

/*
 * Copyright 2008-2009 MOPAS(Ministry of Public Administration and Security).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package egovframework.rte.fdl.property;

import java.util.Collection;
import java.util.Iterator;
import java.util.Vector;

import egovframework.rte.fdl.cmmn.exception.FdlException;

/**
 * Property 서비스의 인터페이스 클래스
 * 
 * <p><b>NOTE</b>: 이 서비스를 통해 어플리케이션에서 유일한 키값으로 키/값쌍을 가지고 오도록 서비스 한다.</p>
 * 
 * @author 실행환경 개발팀 김태호
 * @since 2009.02.01
 * @version 1.0
 * @see <pre>
 *  == 개정이력(Modification Information) ==
 *
 *   수정일      수정자           수정내용
 *  -------    --------    ---------------------------
 *   2009.02.01  김태호          최초 생성
 *
 * </pre>
 */
public interface EgovPropertyService {

    /**
     * boolean 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return boolean 타입의 값
     */
    boolean getBoolean(String name);

    /**
     * boolean 타입의 프로퍼티 값 얻기(디폴트값을 입력받음)
     * 
     * @param name 프로퍼티키
     * @param def 디폴트 값
     * @return boolean 타입의 값
     */
    boolean getBoolean(String name, boolean def);

    /**
     * double 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return double 타입의 값
     */
    double getDouble(String name);

    /**
     * double 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @param def 디폴트 값
     * @return double 타입의 값
     */
    double getDouble(String name, double def);

    /**
     * float 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return Float 타입의 값
     */
    float getFloat(String name);

    /**
     * float 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @param def 디폴트 값
     * @return float 타입의 값
     */
    float getFloat(String name, float def);

    /**
     * int 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return int 타입의 값
     */
    int getInt(String name);

    /**
     * int 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @param def 디폴트 값
     * @return int 타입의 값
     */
    int getInt(String name, int def);

    /**
     * 프로퍼티 키 목록 읽기
     * 
     * @return Key를 위한 Iterator
     */
    Iterator<?> getKeys();

    /**
     * prefix를 이용한 키 목록 읽기
     * 
     * @param prefix prefix
     * @return prefix에 매칭되는 키목록
     */
    Iterator<?> getKeys(String prefix);

    /**
     * long 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return long 타입의 값
     */
    long getLong(String name);

    /**
     * long 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @param def 디폴트 값
     * @return long 타입의 값
     */
    long getLong(String name, long def);

    /**
     * String 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return String 타입의 값
     */
    String getString(String name);

    /**
     * String 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @param def 디폴트 값
     * @return String 타입의 값
     */
    String getString(String name, String def);

    /**
     * String[] 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return String[] 타입의 값
     */
    String[] getStringArray(String name);

    /**
     * Vector 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @return Vector 타입의 값
     */
    Vector<?> getVector(String name);

    /**
     * Vector 타입의 프로퍼티 값 얻기
     * 
     * @param name 프로퍼티키
     * @param def 디폴트 값
     * @return Vector 타입의 값
     */
    Vector<?> getVector(String name, Vector<?> def);

    /**
     * resource 변경시 refresh
     */
    void refreshPropertyFiles() throws FdlException;

    /**
     * 전체 키/값 쌍 얻기
     * 
     * @return Collection 타입의 값
     */
    Collection<?> getAllKeyValue();

}