1 package org.apache.velocity.runtime;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "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 import org.apache.velocity.runtime.parser.Parser;
23
24
25 /**
26 * Provides instances of parsers as needed. get() will return a new parser if
27 * available. If a parser is acquired from the pool, put() should be called
28 * with that parser to make it available again for reuse.
29 *
30 * @author <a href="mailto:sergek@lokitech.com">Serge Knystautas</a>
31 * @version $Id: RuntimeInstance.java 384374 2006-03-08 23:19:30Z nbubna $
32 * @since 1.5
33 */
34 public interface ParserPool
35 {
36 /**
37 * Initialize the pool so that it can begin serving parser instances.
38 * @param svc
39 */
40 void initialize(RuntimeServices svc);
41
42 /**
43 * Retrieve an instance of a parser pool.
44 * @return A parser object.
45 */
46 Parser get();
47
48 /**
49 * Return the parser to the pool so that it may be reused.
50 * @param parser
51 */
52 void put(Parser parser);
53 }