1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/share/classes/com/sun/tools/javac/api/Formattable.java Thu Jul 24 19:06:57 2008 +0100 1.3 @@ -0,0 +1,51 @@ 1.4 +/* 1.5 + * Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. 1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.7 + * 1.8 + * This code is free software; you can redistribute it and/or modify it 1.9 + * under the terms of the GNU General Public License version 2 only, as 1.10 + * published by the Free Software Foundation. Sun designates this 1.11 + * particular file as subject to the "Classpath" exception as provided 1.12 + * by Sun in the LICENSE file that accompanied this code. 1.13 + * 1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT 1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1.17 + * version 2 for more details (a copy is included in the LICENSE file that 1.18 + * accompanied this code). 1.19 + * 1.20 + * You should have received a copy of the GNU General Public License version 1.21 + * 2 along with this work; if not, write to the Free Software Foundation, 1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1.23 + * 1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or 1.26 + * have any questions. 1.27 + */ 1.28 + 1.29 +package com.sun.tools.javac.api; 1.30 + 1.31 +import java.util.ResourceBundle; 1.32 + 1.33 +/** 1.34 + * This interface must be implemented by any javac class that has non-trivial 1.35 + * formatting needs (e.g. where toString() does not apply because of localization). 1.36 + * 1.37 + * @author Maurizio Cimadamore 1.38 + */ 1.39 +public interface Formattable { 1.40 + 1.41 + /** 1.42 + * Used to obtain a localized String representing the object accordingly 1.43 + * to a given locale 1.44 + * 1.45 + * @param bundle resource bundle class used for localization 1.46 + * @return a locale-dependent string representing the object 1.47 + */ 1.48 + public String toString(ResourceBundle bundle); 1.49 + /** 1.50 + * Retrieve a pretty name of this object's kind 1.51 + * @return a string representing the object's kind 1.52 + */ 1.53 + String getKind(); 1.54 +}