01: package org.apache.velocity.runtime.resource.util;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21:
22: /**
23: * A StringResourceRepository functions as a central repository for Velocity templates
24: * stored in Strings.
25: *
26: * @author <a href="mailto:eelco.hillenius@openedge.nl">Eelco Hillenius</a>
27: * @author <a href="mailto:henning@apache.org">Henning P. Schmiedehausen</a>
28: * @version $Id: StringResourceRepository.java 479058 2006-11-25 00:26:32Z henning $
29: */
30: public interface StringResourceRepository {
31: /**
32: * get the string resource that is stored with given key
33: * @param name String name to retrieve from the repository.
34: * @return A StringResource containing the template.
35: */
36: StringResource getStringResource(String name);
37:
38: /**
39: * add a string resource with given key.
40: * @param name The String name to store the template under.
41: * @param body A String containing a template.
42: */
43: void putStringResource(String name, String body);
44:
45: /**
46: * delete a string resource with given key.
47: * @param name The string name to remove from the repository.
48: */
49: void removeStringResource(String name);
50:
51: /**
52: * Sets the encoding of the repository. The encoding should be stored per
53: * template string so that multiple encodings can be stored in a single repository.
54: * The default implementation does this correctly.
55: *
56: * @param encoding The encoding to use.
57: */
58: void setEncoding(String encoding);
59:
60: /**
61: * Returns the current encoding of this repository.
62: *
63: * @return The current encoding of this repository.
64: */
65: String getEncoding();
66: }
|