Source code: com/aendvari/common/notices/NoticeTranslator.java
1 /*
2 * NoticeTranslator.java
3 *
4 * Copyright (c) 2001, 2002 Aendvari, Ltd. All Rights Reserved.
5 *
6 * See the file LICENSE for terms of use.
7 *
8 */
9
10 package com.aendvari.common.notices;
11
12 import java.util.Collection;
13
14
15 /**
16 * <p>Defines an interface for the translation of {@link Notice} objects into text.</p>
17 *
18 * @author Scott Milne
19 *
20 */
21
22 public interface NoticeTranslator
23 {
24 /**
25 * Translates a single notice.
26 *
27 * @param notice The {@link Notice} object to translate.
28 *
29 * @return A string containing the translated notice text.
30 *
31 */
32
33 public String translate(Notice notice);
34
35 /**
36 * Translates a <code>Collection</code> of notices.
37 *
38 * @param notices A <code>Collection</code> of {@link Notice} objects to translate.
39 *
40 * @return A <code>Collection</code> of strings containing translated notice text.
41 *
42 */
43
44 public Collection translate(Collection notices);
45
46 /**
47 * Translates an array of notices.
48 *
49 * @param notices An array of {@link Notice} objects to translate.
50 *
51 * @return An array of strings containing translated notice text.
52 *
53 */
54
55 public String[] translate(Notice[] notices);
56 }
57