View Javadoc

1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the "License").  You may not use this file except 
5    * in compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * http://www.sun.com/cddl/cddl.html. 
9    * See the License for the specific language governing 
10   * permissions and limitations under the License.
11   * 
12   * When distributing Covered Code, include this CDDL 
13   * HEADER in each file and include the License file at 
14   * license.txt.  If applicable, add the following below 
15   * this CDDL HEADER, with the fields enclosed by brackets 
16   * "[]" replaced with your own identifying information: 
17   * Portions Copyright [yyyy] [name of copyright owner]
18   * 
19   * Portions Copyright 2004 eBay, Inc.
20   */
21  package com.ebay.carad.os.vitalsigns.templates;
22  
23  /***
24   * Represents an object which has the facility for its contents to be template-formatted
25   * based on a set of passed-in objects. Generally, this will be achieved by using a MessageFormat
26   * to introduce the passed-in objects into fields of the templatizable host that are known
27   * to be templatizable. For instance, a class may choose to take only the first passed-in
28   * parameter and use it only to format its title field.
29   * 
30   * @author Jeremy Kraybill
31   * @version $Id$
32   */
33  public interface ITemplatizable {
34  
35  	/***
36  	 * Template-formats the given object with a set of parameters.
37  	 * 
38  	 * @param params an array of objects (usually strings) to use for templatization
39  	 */
40  	public void templatize(Object[] params);
41  
42  }