Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
TemplateToken |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.parse; | |
16 | ||
17 | import org.apache.hivemind.Locatable; | |
18 | import org.apache.hivemind.Location; | |
19 | import org.apache.hivemind.util.ToStringBuilder; | |
20 | ||
21 | /** | |
22 | * Base class for a number of different types of tokens that can be extracted from a page/component | |
23 | * template. This class defines the type of the token, subclasses provide interpretations on the | |
24 | * token. | |
25 | * | |
26 | * @author Howard Lewis Ship | |
27 | */ | |
28 | ||
29 | public abstract class TemplateToken implements Locatable | |
30 | { | |
31 | private TokenType _type; | |
32 | ||
33 | private Location _location; | |
34 | ||
35 | protected TemplateToken(TokenType type, Location location) | |
36 | 0 | { |
37 | 0 | _type = type; |
38 | 0 | _location = location; |
39 | 0 | } |
40 | ||
41 | public TokenType getType() | |
42 | { | |
43 | 0 | return _type; |
44 | } | |
45 | ||
46 | public Location getLocation() | |
47 | { | |
48 | 0 | return _location; |
49 | } | |
50 | ||
51 | public String toString() | |
52 | { | |
53 | 0 | ToStringBuilder builder = new ToStringBuilder(this); |
54 | ||
55 | 0 | builder.append("type", _type.getName()); |
56 | 0 | builder.append("location", _location); |
57 | ||
58 | 0 | extendDescription(builder); |
59 | ||
60 | 0 | return builder.toString(); |
61 | } | |
62 | ||
63 | /** | |
64 | * Overridden in subclasses to append additional fields (defined in the subclass) to the | |
65 | * description. Subclasses may override this method without invoking this implementation, which | |
66 | * is empty. | |
67 | * | |
68 | * @since 3.0 | |
69 | */ | |
70 | ||
71 | protected void extendDescription(ToStringBuilder builder) | |
72 | { | |
73 | 0 | } |
74 | } |