View Javadoc

1   /*
2    * Copyright (c) 2001-2004,
3    * RedVerst Group, ISP RAS http://www.ispras.ru
4    * All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions are met:
8    *
9    * 1. Redistributions of source code must retain the above copyright notice, this
10   *    list of conditions and the following disclaimer.
11   *
12   * 2. Redistributions in binary form must reproduce the above copyright notice,
13   *    this list of conditions and the following disclaimer in the documentation
14   *    and/or other materials provided with the distribution.
15   *
16   * 3. The names "ATP", "TreeDL", "RedVerst", "ISP RAS"
17   *    may not be used to endorse or promote products derived from this software
18   *    without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
24   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
27   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  
32  package com.unitesk.atp.messages;
33  
34  /***
35   * The message box for application messages.
36   *
37   * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
38   * @version $Id: MessageBox.java,v 1.5 2005/07/08 15:35:55 all-x Exp $
39   */
40  public interface MessageBox
41  {
42      /***
43       * Outputs error message and stops program execution.
44       * Increments error counter.
45       *
46       * @param  message The error message.
47       */
48      void fatal( Message message );
49  
50      /***
51       * Outputs error message.
52       * Increments error counter.
53       *
54       * @param  message The error message.
55       */
56      void error( Message message );
57  
58      /***
59       * Outputs warning message.
60       * Increments warning counter.
61       *
62       * @param  message The warning message.
63       */
64      void warning( Message message );
65  
66      /***
67       * TODO: make deprecated
68       * 
69       * Outputs information message.
70       * Increments information counter.
71       *
72       * @param  message The information message.
73       */
74      void info( Message message );
75  
76      /***
77       * Outputs information line.
78       * Increments information counter.
79       *
80       * @param  message The information message.
81       */
82      void info( String message );
83  
84      /***
85       * Returns error messages count.
86       *
87       * @return  The error count.
88       */
89      int getErrorCount();
90  
91      /***
92       * Returns warning messages count.
93       *
94       * @return  The warning count.
95       */
96      int getWarningCount();
97  
98      /***
99       * Returns information messages count.
100      *
101      * @return  The info count.
102      */
103     int getInfoCount();
104 
105     /***
106      * Prints message box statistics.
107      */
108     void statistics();
109 
110     /***
111      * If error count greater than zero,
112      * prints statistics and stops program execution.
113      */
114     void status();
115 
116     /***
117      * Stops program execution by throwing {@link FatalErrorException}.
118      *
119      * @param code    Exit status code
120      */
121     void stop( int code );
122 
123     /***
124      * Returns localized string manager for this message box.
125      * Localized string manager is used to translate messages to text.
126      */
127     MessageStringManager getStringManager();
128 }