Formatter


1   /*
2    * Copyright 2006 Google Inc.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5    * use this file except in compliance with the License. You may obtain a copy of
6    * the License at
7    * 
8    * http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations under
14   * the License.
15   */
16  package com.google.gwt.dev.util.msg;
17  
18  /**
19   * Abstract formatter used by {@link Message}.
20   */
21  public abstract class Formatter {
22  
23    /**
24     * Transforms the specified object into a string format.
25     * 
26     * @param toFormat the object to format; the caller is responsible for 
27     * ensuring that the type of the passed-in object is the type expected 
28     * by the subclass
29     * 
30     * @throws ClassCastException if <code>toFormat</code> is not of the type expected by the subclass
31     */
32    public abstract String   format(Object   toFormat);
33  }
34

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags