1 /**
2 * This file Copyright (c) 2013-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.i18nsystem.tools;
35
36 import java.util.Locale;
37
38 /**
39 * Represents a "to-do" for translations.
40 */
41 public interface GeneratorResult {
42 /**
43 * A new key with a known text needs to be added.
44 */
45 public class AddKeyToNewBundle implements GeneratorResult {
46 private final Locale locale;
47 private final String key;
48 private final String text;
49
50 public AddKeyToNewBundle(Locale locale, String key, String text) {
51 this.locale = locale;
52 this.key = key;
53 this.text = text;
54 }
55 }
56
57 /**
58 * A new key needs to be added and translated.
59 */
60 public class AddUntranslatedKeyToNewBundle implements GeneratorResult {
61 private final Locale locale;
62 private final String key;
63
64 public AddUntranslatedKeyToNewBundle(Locale locale, String key) {
65 this.locale = locale;
66 this.key = key;
67 }
68 }
69
70 /**
71 * A key needs to be removed from a bundle.
72 */
73 public class RemoveKeyFromLegacyBundle implements GeneratorResult {
74 private final String pathToFile;
75 private final String basename;
76 private final String key;
77
78 public RemoveKeyFromLegacyBundle(String basename, String key, String pathToFile) {
79 this.pathToFile = pathToFile;
80 this.basename = basename;
81 this.key = key;
82 }
83 }
84
85 }