blob: 11b031662a27f098cf15b839812c8aca82e0d2b8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
package org.apache.velocity.context;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.velocity.Template;
import org.apache.velocity.runtime.resource.Resource;
import org.apache.velocity.util.introspection.IntrospectionCacheData;
import java.util.List;
/**
* interface to encapsulate the 'stuff' for internal operation of velocity.
* We use the context as a thread-safe storage : we take advantage of the
* fact that it's a visitor of sorts to all nodes (that matter) of the
* AST during init() and render().
*
* Currently, it carries the template name for namespace
* support, as well as node-local context data introspection caching.
*
* @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
* @author <a href="mailto:Christoph.Reck@dlr.de">Christoph Reck</a>
* @version $Id$
*/
interface InternalHousekeepingContext
{
/**
* set the current template name on top of stack
*
* @param s current template name
*/
void pushCurrentTemplateName( String s );
/**
* remove the current template name from stack
*/
void popCurrentTemplateName();
/**
* get the current template name
*
* @return String current template name
*/
String getCurrentTemplateName();
/**
* Returns the template name stack in form of an array.
*
* @return String[] with the template name stack contents.
*/
String[] getTemplateNameStack();
/**
* set the current macro name on top of stack
*
* @param s current macro name
*/
void pushCurrentMacroName( String s );
/**
* remove the current macro name from stack
*/
void popCurrentMacroName();
/**
* get the current macro name
*
* @return String current macro name
*/
String getCurrentMacroName();
/**
* get the current macro call depth
*
* @return int current macro call depth
*/
int getCurrentMacroCallDepth();
/**
* Returns the macro name stack in form of an array.
*
* @return String[] with the macro name stack contents.
*/
String[] getMacroNameStack();
/**
* returns an IntrospectionCache Data (@see IntrospectionCacheData)
* object if exists for the key
*
* @param key key to find in cache
* @return cache object
*/
IntrospectionCacheData icacheGet( Object key );
/**
* places an IntrospectionCache Data (@see IntrospectionCacheData)
* element in the cache for specified key
*
* @param key key
* @param o IntrospectionCacheData object to place in cache
*/
void icachePut( Object key, IntrospectionCacheData o );
/**
* temporary fix to enable #include() to figure out
* current encoding.
*
* @return The current resource.
*/
Resource getCurrentResource();
/**
* @param r
*/
void setCurrentResource( Resource r );
/**
* Set the macro library list for the current template.
*
* @param macroLibraries list of macro libraries to set
*/
void setMacroLibraries(List<Template> macroLibraries);
/**
* Get the macro library list for the current template.
*
* @return List of macro library names
*/
List<Template> getMacroLibraries();
}
|
