001    /*
002     * Copyright (c) 2009 The openGion Project.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *     http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013     * either express or implied. See the License for the specific language
014     * governing permissions and limitations under the License.
015     */
016    package org.opengion.fukurou.process;
017    
018    /**
019     * HybsProcess 縺ｯ縲√ヰ繝?メ蜃ｦ逅?し繝悶け繝ｩ繧ｹ縺ｮ蜈ｱ騾壹う繝ｳ繧ｿ繝ｼ繝輔ぉ繝ｼ繧ｹ縺ｧ縺吶?
020     * HybsProcess 繧堤畑縺?※縲??谺｡縲√ヰ繝?メ繝励Ο繧ｻ繧ｹ繧貞ｮ溯｡後☆繧九％縺ｨ縺後〒縺阪∪縺吶?
021     *
022     * @version  4.0
023     * @author   Kazuhiko Hasegawa
024     * @since    JDK5.0,
025     */
026    public interface HybsProcess {
027    
028            /**
029             * 蠑墓焚蠖｢蠑上ｒ隗｣譫舌☆繧?Argument 繧ｪ繝悶ず繧ｧ繧ｯ繝医↓縲∝ｼ墓焚繧定ｨｭ螳壹＠縺ｾ縺吶?
030             * Argument 縺ｮ譁?ｭ怜?縺九ｉ縲∝ｼ墓焚縺九?繝ｭ繝代ユ繧｣繧偵そ繝?ヨ縺励∪縺吶?
031             * ?ｻ繝励Ο繝代ユ繧｣?ｽ縺ｮ繧ｭ繝ｼ驛ｨ縺ｮ螟ｧ譁?ｭ暦ｽ･蟆乗枚蟄励?縲∝宍譬ｼ縺ｫ蛻､螳壹＠縺ｦ縺?∪縺吶?
032             * Argument 縺ｮ譁?ｭ怜?縺ｫ縺ｯ縲√ち繧､繝励′縺ゅｊ縺ｾ縺吶?
033             *
034             * ?ｻ繧ｳ繝｡繝ｳ繝茨ｼｽ  ??# 縺ｧ蟋九∪繧句ｼ墓焚縺ｧ縲∽ｽｿ逕ｨ縺輔ｌ縺ｾ縺帙ｓ縲?逋ｻ骭ｲ繧ゅ＆繧後∪縺帙ｓ縲?
035             * ?ｻ蠑墓焚?ｽ      ??#,-,= 莉･螟悶〒蟋九∪繧矩?蟶ｸ縺ｮ譁?ｭ怜?縲ら匳骭ｲ縺ｮ鬆?分縺梧欠螳壹＆繧後∪縺吶?
036             * ?ｻ繝励Ο繝代ユ繧｣?ｽ??- 縺ｧ蟋九∪繧翫?繧ｭ繝ｼ縺ｨ蛟､繧?縺ｧ蛹ｺ蛻?▲縺ｦ縺?ｋ繝代Λ繝｡繝ｼ繧ｿ縺ｧ縺吶?鬆?ｺ上?辟｡髢｢菫ゅ?
037             *
038             * @param   arg 蠑墓焚
039             */
040            void putArgument( String arg ) ;
041    
042            /**
043             * Argument 縺ｮ譁?ｭ怜?縺九ｉ縲√?繝ｭ繝代ユ繧｣繧偵そ繝?ヨ縺励∪縺吶?
044             * ?ｻ繝励Ο繝代ユ繧｣?ｽ縺ｮ繧ｭ繝ｼ驛ｨ縺ｮ螟ｧ譁?ｭ暦ｽ･蟆乗枚蟄励?縲∝宍譬ｼ縺ｫ蛻､螳壹＠縺ｦ縺?∪縺吶?
045             * 縺薙?繝｡繧ｽ繝?ラ縺ｯ縲∝ｼ墓焚 繧?繧ｳ繝｡繝ｳ繝医?蛻､譁ｭ繧定｡後＞縺ｾ縺帙ｓ縲ゅ?繝ｭ繝代ユ繧｣ 縺ｮ縺ｿ
046             * 險ｭ螳壹＆繧後ｋ繧ゅ?縺ｨ縺励※縲∝?逅?＠縺ｾ縺吶?
047             * 繝励Ο繝代ユ繧｣縺ｮ key=val 縺悟?繧√°繧牙?蜑ｲ縺輔ｌ縺ｦ縺?ｋ蝣ｴ蜷医?邁｡譏薙Γ繧ｽ繝?ラ縺ｧ縺吶?
048             *
049             * @param   key 繧ｭ繝ｼ
050             * @param   val 蛟､
051             */
052            void putArgument( String key,String val );
053    
054            /**
055             * 繝励Ο繧ｻ繧ｹ縺ｮ蛻晄悄蛹悶ｒ陦後＞縺ｾ縺吶?蛻昴ａ縺ｫ荳?ｺｦ縺?￠縲∝他縺ｳ蜃ｺ縺輔ｌ縺ｾ縺吶?
056             * 蛻晄悄蜃ｦ逅?繝輔ぃ繧､繝ｫ繧ｪ繝ｼ繝励Φ縲?ｼ､?｢繧ｪ繝ｼ繝励Φ遲?縺ｫ菴ｿ逕ｨ縺励∪縺吶?
057             * 蠑墓焚縺ｮ ParamProcess 縺ｯ縲√ョ繝ｼ繧ｿ繝吶?繧ｹ謗･邯壹?繝ｭ繧ｰ繝輔ぃ繧､繝ｫ縲?
058             * 繧ｨ繝ｩ繝ｼ譎ゅΓ繝ｼ繝ｫ騾∽ｿ｡縺ｪ縺ｩ縺ｮ蝓ｺ譛ｬ險ｭ螳壹ｒ邂｡逅?＠縺ｦ縺?ｋ繧､繝ｳ繧ｿ繝ｼ繝輔ぉ繝ｼ繧ｹ
059             * 縺ｧ縺吶?
060             *
061             * @param   paramProcess 繝??繧ｿ繝吶?繧ｹ縺ｮ謗･邯壼?諠??縺ｪ縺ｩ繧呈戟縺｣縺ｦ縺?ｋ繧ｪ繝悶ず繧ｧ繧ｯ繝?
062             */
063            void init( ParamProcess paramProcess ) ;
064    
065            /**
066             * 繝励Ο繧ｻ繧ｹ縺ｮ邨ゆｺ?ｒ陦後＞縺ｾ縺吶?譛?ｾ後↓荳?ｺｦ縺?￠縲∝他縺ｳ蜃ｺ縺輔ｌ縺ｾ縺吶?
067             * 邨ゆｺ??逅?繝輔ぃ繧､繝ｫ繧ｯ繝ｭ繝ｼ繧ｺ縲?ｼ､?｢繧ｯ繝ｭ繝ｼ繧ｺ遲?縺ｫ菴ｿ逕ｨ縺励∪縺吶?
068             *
069             * @param   isOK 繝医?繧ｿ繝ｫ縺ｧ縲＾K縺?▲縺溘°縺ｩ縺?° [true:謌仙粥/false:螟ｱ謨余
070             */
071            void end( boolean isOK ) ;
072    
073            /**
074             * 繝?ぅ繧ｹ繝励Ξ繧､縺ｫ繝｡繝?そ繝ｼ繧ｸ繧定｡ｨ遉ｺ縺励∪縺吶?
075             *
076             * @param       msg     陦ｨ遉ｺ縺吶ｋ繝｡繝?そ繝ｼ繧ｸ
077             */
078            void println( final String msg ) ;
079    
080            /**
081             * 繝ｭ繧ｰ繝輔ぃ繧､繝ｫ縺ｫ繝｡繝?そ繝ｼ繧ｸ繧定｡ｨ遉ｺ縺励∪縺吶?
082             *
083             * @param       msg     陦ｨ遉ｺ縺吶ｋ繝｡繝?そ繝ｼ繧ｸ
084             */
085            void logging( final String msg ) ;
086    
087            /**
088             * 繝?ぅ繧ｹ繝励Ξ繧､蜃ｺ蜉帙☆繧?LoggerProcess 繧ｪ繝悶ず繧ｧ繧ｯ繝医ｒ繧ｻ繝?ヨ縺励∪縺吶?
089             *
090             * @param logger LoggerProcess繧ｪ繝悶ず繧ｧ繧ｯ繝?
091             */
092            void setLoggerProcess( final LoggerProcess logger );
093    
094            /**
095             * 繝励Ο繧ｻ繧ｹ縺ｮ蜃ｦ逅?ｵ先棡縺ｮ繝ｬ繝昴?繝郁｡ｨ迴ｾ繧定ｿ斐＠縺ｾ縺吶?
096             * 蜃ｦ逅??繝ｭ繧ｰ繝ｩ繝?錐縲∝?蜉帑ｻｶ謨ｰ縲∝?蜉帑ｻｶ謨ｰ縺ｪ縺ｩ縺ｮ諠??縺ｧ縺吶?
097             * 縺薙?譁?ｭ怜?繧偵◎縺ｮ縺ｾ縺ｾ縲∵ｨ呎ｺ門?蜉帙↓蜃ｺ縺吶％縺ｨ縺ｧ縲∫ｵ先棡繝ｬ繝昴?繝医→蜃ｺ譚･繧九ｈ縺?↑
098             * 蠖｢蠑上〒蜃ｺ縺励※縺上□縺輔＞縲?
099             *
100             * @return   蜃ｦ逅?ｵ先棡縺ｮ繝ｬ繝昴?繝?
101             */
102            String report() ;
103    
104            /**
105             * 縺薙?繧ｯ繝ｩ繧ｹ縺ｮ菴ｿ逕ｨ譁ｹ豕輔ｒ霑斐＠縺ｾ縺吶?
106             *
107             * @return      縺薙?繧ｯ繝ｩ繧ｹ縺ｮ菴ｿ逕ｨ譁ｹ豕?
108             */
109            String usage() ;
110    
111    }