View Javadoc

1   package org.apache.velocity.util;
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  /**
23   * Any object in the context which implements TemplateNumber will be treated
24   * as a number for the purposes of arithmetic operations and comparison.
25   *
26   * @author <a href="mailto:wglass@forio.com">Will Glass-Husain</a>
27   */
28  public interface TemplateNumber
29  {
30  
31     /**
32      * Returns a Number that can be used in a template.
33      * @return A Number that can be used in a template.
34      */
35     public Number getAsNumber();
36  
37  }