Package com.sun.tools.javac.code

Class Printer

java.lang.Object

com.sun.tools.javac.code.Printer

All Implemented Interfaces:

Symbol.Visitor<String,Locale>, Type.Visitor<String,Locale>

Direct Known Subclasses:

RichDiagnosticFormatter.RichPrinter

public abstract class Printer
extends Object
implements Type.Visitor<String,Locale>, Symbol.Visitor<String,Locale>

A combined type/symbol visitor for generating non-trivial localized string representation of types and symbols.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Printer()

Method Summary

Modifier and Type	Method and Description
protected abstract String	capturedVarId(Type.CapturedType t, Locale locale) Maps a captured type into an unique identifier.
protected String	className(Type.ClassType t, boolean longform, Locale locale) Converts a class name into a (possibly localized) string.
static Printer	createStandardPrinter(Messages messages) Create a printer with default i18n support provided by Messages.
protected abstract String	localize(Locale locale, String key, Object... args) This method should be overriden in order to provide proper i18n support.
protected String	printMethodArgs(List<Type> args, boolean varArgs, Locale locale) Converts a set of method argument types into their corresponding localized string representation.
String	visit(Symbol s, Locale locale) Get a localized string representation for a given symbol.
String	visit(Type t, Locale locale) Get a localized string representation for a given type.
String	visitAnnotatedType(Type.AnnotatedType t, Locale locale)
String	visitArrayType(Type.ArrayType t, Locale locale)
String	visitCapturedType(Type.CapturedType t, Locale locale)
String	visitClassSymbol(Symbol.ClassSymbol sym, Locale locale)
String	visitClassType(Type.ClassType t, Locale locale)
String	visitErrorType(Type.ErrorType t, Locale locale)
String	visitForAll(Type.ForAll t, Locale locale)
String	visitMethodSymbol(Symbol.MethodSymbol s, Locale locale)
String	visitMethodType(Type.MethodType t, Locale locale)
String	visitOperatorSymbol(Symbol.OperatorSymbol s, Locale locale)
String	visitPackageSymbol(Symbol.PackageSymbol s, Locale locale)
String	visitPackageType(Type.PackageType t, Locale locale)
String	visitSymbol(Symbol s, Locale locale)
String	visitSymbols(List<Symbol> ts, Locale locale) * Get a localized string representation for all the symbols in the input list.
String	visitType(Type t, Locale locale)
String	visitTypes(List<Type> ts, Locale locale) Get a localized string representation for all the types in the input list.
String	visitTypeSymbol(Symbol.TypeSymbol s, Locale locale)
String	visitTypeVar(Type.TypeVar t, Locale locale)
String	visitUndetVar(Type.UndetVar t, Locale locale)
String	visitVarSymbol(Symbol.VarSymbol s, Locale locale)
String	visitWildcardType(Type.WildcardType t, Locale locale)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Printer

protected Printer()

Method Detail

localize

protected abstract String localize(Locale locale,
                                   String key,
                                   Object... args)

This method should be overriden in order to provide proper i18n support.

Parameters:

locale - the locale in which the string is to be rendered

key - the key corresponding to the message to be displayed

args - a list of optional arguments

Returns:

localized string representation

capturedVarId

protected abstract String capturedVarId(Type.CapturedType t,
                                        Locale locale)

Maps a captured type into an unique identifier.

Parameters:

t - the captured type for which an id is to be retrieved

locale - locale settings

Returns:

unique id representing this captured type

createStandardPrinter

public static Printer createStandardPrinter(Messages messages)

Create a printer with default i18n support provided by Messages. By default, captured types ids are generated using hashcode.

Parameters:

messages - Messages class to be used for i18n

Returns:

printer visitor instance

visitTypes

public String visitTypes(List<Type> ts,
                         Locale locale)

Get a localized string representation for all the types in the input list.

Parameters:

ts - types to be displayed

locale - the locale in which the string is to be rendered

Returns:

localized string representation

visitSymbols

public String visitSymbols(List<Symbol> ts,
                           Locale locale)

* Get a localized string representation for all the symbols in the input list.

Parameters:

ts - symbols to be displayed

locale - the locale in which the string is to be rendered

Returns:

localized string representation

visit

public String visit(Type t,
                    Locale locale)

Get a localized string representation for a given type.

Parameters:

t - type to be displayed

locale - the locale in which the string is to be rendered

Returns:

localized string representation

visit

public String visit(Symbol s,
                    Locale locale)

Get a localized string representation for a given symbol.

Parameters:

s - symbol to be displayed

locale - the locale in which the string is to be rendered

Returns:

localized string representation

visitCapturedType

public String visitCapturedType(Type.CapturedType t,
                                Locale locale)

Specified by:

visitCapturedType in interface Type.Visitor<String,Locale>

visitForAll

public String visitForAll(Type.ForAll t,
                          Locale locale)

Specified by:

visitForAll in interface Type.Visitor<String,Locale>

visitUndetVar

public String visitUndetVar(Type.UndetVar t,
                            Locale locale)

Specified by:

visitUndetVar in interface Type.Visitor<String,Locale>

visitArrayType

public String visitArrayType(Type.ArrayType t,
                             Locale locale)

Specified by:

visitArrayType in interface Type.Visitor<String,Locale>

visitClassType

public String visitClassType(Type.ClassType t,
                             Locale locale)

Specified by:

visitClassType in interface Type.Visitor<String,Locale>

visitMethodType

public String visitMethodType(Type.MethodType t,
                              Locale locale)

Specified by:

visitMethodType in interface Type.Visitor<String,Locale>

visitPackageType

public String visitPackageType(Type.PackageType t,
                               Locale locale)

Specified by:

visitPackageType in interface Type.Visitor<String,Locale>

visitWildcardType

public String visitWildcardType(Type.WildcardType t,
                                Locale locale)

Specified by:

visitWildcardType in interface Type.Visitor<String,Locale>

visitErrorType

public String visitErrorType(Type.ErrorType t,
                             Locale locale)

Specified by:

visitErrorType in interface Type.Visitor<String,Locale>

visitTypeVar

public String visitTypeVar(Type.TypeVar t,
                           Locale locale)

Specified by:

visitTypeVar in interface Type.Visitor<String,Locale>

visitAnnotatedType

public String visitAnnotatedType(Type.AnnotatedType t,
                                 Locale locale)

Specified by:

visitAnnotatedType in interface Type.Visitor<String,Locale>

visitType

public String visitType(Type t,
                        Locale locale)

Specified by:

visitType in interface Type.Visitor<String,Locale>

className

protected String className(Type.ClassType t,
                           boolean longform,
                           Locale locale)

Converts a class name into a (possibly localized) string. Anonymous inner classes get converted into a localized string.

Parameters:

t - the type of the class whose name is to be rendered

longform - if set, the class' fullname is displayed - if unset the short name is chosen (w/o package)

locale - the locale in which the string is to be rendered

Returns:

localized string representation

printMethodArgs

protected String printMethodArgs(List<Type> args,
                                 boolean varArgs,
                                 Locale locale)

Converts a set of method argument types into their corresponding localized string representation.

Parameters:

args - arguments to be rendered

varArgs - if true, the last method argument is regarded as a vararg

locale - the locale in which the string is to be rendered

Returns:

localized string representation

visitClassSymbol

public String visitClassSymbol(Symbol.ClassSymbol sym,
                               Locale locale)

Specified by:

visitClassSymbol in interface Symbol.Visitor<String,Locale>

visitMethodSymbol

public String visitMethodSymbol(Symbol.MethodSymbol s,
                                Locale locale)

Specified by:

visitMethodSymbol in interface Symbol.Visitor<String,Locale>

visitOperatorSymbol

public String visitOperatorSymbol(Symbol.OperatorSymbol s,
                                  Locale locale)

Specified by:

visitOperatorSymbol in interface Symbol.Visitor<String,Locale>

visitPackageSymbol

public String visitPackageSymbol(Symbol.PackageSymbol s,
                                 Locale locale)

Specified by:

visitPackageSymbol in interface Symbol.Visitor<String,Locale>

visitTypeSymbol

public String visitTypeSymbol(Symbol.TypeSymbol s,
                              Locale locale)

Specified by:

visitTypeSymbol in interface Symbol.Visitor<String,Locale>

visitVarSymbol

public String visitVarSymbol(Symbol.VarSymbol s,
                             Locale locale)

Specified by:

visitVarSymbol in interface Symbol.Visitor<String,Locale>

visitSymbol

public String visitSymbol(Symbol s,
                          Locale locale)

Specified by:

visitSymbol in interface Symbol.Visitor<String,Locale>