1 /*
2 * This file is part of Pease Plate Template Engine.
3 *
4 * Pease Plate Template Engine is free software: you can redistribute
5 * it and/or modify it under the terms of the GNU Lesser General
6 * Public License as published by the Free Software Foundation,
7 * either version 3 of the License, or any later version.
8 *
9 * Pease Plate Template Engine is distributed in the hope that it
10 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
11 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * See the GNU Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with Pease Plate Template Engine. If not, see
16 * <http://www.gnu.org/licenses/>.
17 *
18 * Copyright (c) 2008 Manfred HANTSCHEL
19 */
20 package org.peaseplate.locator;
21
22 import org.peaseplate.Messages;
23
24
25 /**
26 * A messages locator knows of the source some messages came from
27 */
28 public interface MessagesLocator extends Locator {
29
30 /**
31 * Loads the messages an returns a messages object containing the messages.
32 * Don't forget to update the timestamp and the rawSize properties
33 * when loading the data.
34 * @return a messages object
35 * @throws TemplateLocatorException on occasion
36 */
37 public Messages load() throws TemplateLocatorException;
38
39 }