01: package org.apache.velocity.runtime;
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: import org.apache.velocity.runtime.parser.Parser;
23:
24: /**
25: * Provides instances of parsers as needed. get() will return a new parser if
26: * available. If a parser is acquired from the pool, put() should be called
27: * with that parser to make it available again for reuse.
28: *
29: * @author <a href="mailto:sergek@lokitech.com">Serge Knystautas</a>
30: * @version $Id: RuntimeInstance.java 384374 2006-03-08 23:19:30Z nbubna $
31: */
32: public interface ParserPool {
33: /**
34: * Initialize the pool so that it can begin serving parser instances.
35: * @param svc
36: */
37: void initialize(RuntimeServices svc);
38:
39: /**
40: * Retrieve an instance of a parser pool.
41: * @return A parser object.
42: */
43: Parser get();
44:
45: /**
46: * Return the parser to the pool so that it may be reused.
47: * @param parser
48: */
49: void put(Parser parser);
50: }
|