Package com.sun.tools.javac.util

Class BasicDiagnosticFormatter.BasicConfiguration

java.lang.Object

com.sun.tools.javac.util.AbstractDiagnosticFormatter.SimpleConfiguration

com.sun.tools.javac.util.BasicDiagnosticFormatter.BasicConfiguration

All Implemented Interfaces:

DiagnosticFormatter.Configuration

Enclosing class:

BasicDiagnosticFormatter

public static class BasicDiagnosticFormatter.BasicConfiguration
extends AbstractDiagnosticFormatter.SimpleConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicDiagnosticFormatter.BasicConfiguration.BasicFormatKind This enum contains all the kinds of formatting patterns supported by a basic diagnostic formatter.
static class	BasicDiagnosticFormatter.BasicConfiguration.SourcePosition A source positioning value controls the position (within a given diagnostic message) in which the source line the diagnostic refers to should be displayed (if applicable)

Nested classes/interfaces inherited from interface com.sun.tools.javac.api.DiagnosticFormatter.Configuration

DiagnosticFormatter.Configuration.DiagnosticPart, DiagnosticFormatter.Configuration.MultilineLimit

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<BasicDiagnosticFormatter.BasicConfiguration.BasicFormatKind,String>	availableFormats
protected Map<DiagnosticFormatter.Configuration.DiagnosticPart,Integer>	indentationLevels
protected BasicDiagnosticFormatter.BasicConfiguration.SourcePosition	sourcePosition

Fields inherited from class com.sun.tools.javac.util.AbstractDiagnosticFormatter.SimpleConfiguration

caretEnabled, multilineLimits, visibleParts

Constructor Summary

Constructors

Constructor and Description
BasicConfiguration()
BasicConfiguration(Options options)

Method Summary

Modifier and Type	Method and Description
String	getFormat(BasicDiagnosticFormatter.BasicConfiguration.BasicFormatKind kind) Get a metachar string for a specific format
int	getIndentation(DiagnosticFormatter.Configuration.DiagnosticPart diagPart) Get the amount of spaces for a given indentation kind
BasicDiagnosticFormatter.BasicConfiguration.SourcePosition	getSourcePosition() Get the source line positioning used by this formatter
void	setFormat(BasicDiagnosticFormatter.BasicConfiguration.BasicFormatKind kind, String s) Set a metachar string for a specific format
void	setIndentation(DiagnosticFormatter.Configuration.DiagnosticPart diagPart, int nSpaces) Set the indentation level for various element of a given diagnostic - this might lead to more readable diagnostics
void	setSourcePosition(BasicDiagnosticFormatter.BasicConfiguration.SourcePosition sourcePos) Set the source line positioning used by this formatter

Methods inherited from class com.sun.tools.javac.util.AbstractDiagnosticFormatter.SimpleConfiguration

getMultilineLimit, getVisible, isCaretEnabled, setCaretEnabled, setMultilineLimit, setVisible, setVisiblePart

Methods inherited from class java.lang.Object

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

Field Detail

indentationLevels

protected Map<DiagnosticFormatter.Configuration.DiagnosticPart,Integer> indentationLevels

availableFormats

protected Map<BasicDiagnosticFormatter.BasicConfiguration.BasicFormatKind,String> availableFormats

sourcePosition

protected BasicDiagnosticFormatter.BasicConfiguration.SourcePosition sourcePosition

Constructor Detail

BasicConfiguration

public BasicConfiguration(Options options)

BasicConfiguration

public BasicConfiguration()

Method Detail

getIndentation

public int getIndentation(DiagnosticFormatter.Configuration.DiagnosticPart diagPart)

Get the amount of spaces for a given indentation kind

Parameters:

diagPart - the diagnostic part for which the indentation is to be retrieved

Returns:

the amount of spaces used for the specified indentation kind

setIndentation

public void setIndentation(DiagnosticFormatter.Configuration.DiagnosticPart diagPart,
                           int nSpaces)

Set the indentation level for various element of a given diagnostic - this might lead to more readable diagnostics

Parameters:

diagPart -

nSpaces - amount of spaces for the specified diagnostic part

setSourcePosition

public void setSourcePosition(BasicDiagnosticFormatter.BasicConfiguration.SourcePosition sourcePos)

Set the source line positioning used by this formatter

Parameters:

sourcePos - a positioning value for source line

getSourcePosition

public BasicDiagnosticFormatter.BasicConfiguration.SourcePosition getSourcePosition()

Get the source line positioning used by this formatter

Returns:

the positioning value used by this formatter

setFormat

public void setFormat(BasicDiagnosticFormatter.BasicConfiguration.BasicFormatKind kind,
                      String s)

Set a metachar string for a specific format

Parameters:

kind - the format kind to be set

s - the metachar string specifying the format

getFormat

public String getFormat(BasicDiagnosticFormatter.BasicConfiguration.BasicFormatKind kind)

Get a metachar string for a specific format

Parameters:

kind - the format kind for which to get the metachar string