Package org.jboss.jdeparser

Class FormatPreferences

java.lang.Object

org.jboss.jdeparser.FormatPreferences

public final class FormatPreferences
extends java.lang.Object

Formatter preferences.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormatPreferences.Indentation	A category of indentation.
static class	FormatPreferences.Opt	Option flags.
static class	FormatPreferences.Space	The location or position of a space.
static class	FormatPreferences.SpaceType	The type of space to apply.
static class	FormatPreferences.Wrapping	Categories for wrapping rules.
static class	FormatPreferences.WrappingMode	The wrapping mode.

Constructor Summary

Constructors

Constructor	Description
FormatPreferences()	Construct a new instance using default values.
FormatPreferences(java.io.File file)	Construct a new instance using a properties file loaded from the given file name.
FormatPreferences(java.io.InputStream inputStream)	Construct a new instance using a properties read from the given stream.
FormatPreferences(java.io.Reader reader)	Construct a new instance using a properties read from the given stream.
FormatPreferences(java.lang.ClassLoader classLoader)	Construct a new instance using a properties file loaded from the given class loader.
FormatPreferences(java.util.Properties properties)	Construct a new instance, mapping the given properties to the formatter configurations.
FormatPreferences(javax.annotation.processing.Filer filer)	Construct a new instance using a properties file loaded from the given annotation processing filer.
FormatPreferences(javax.annotation.processing.Filer filer, java.lang.String name)	Construct a new instance using a properties file loaded from the given annotation processing filer.

Method Summary

Modifier and Type	Method	Description
void	addOption(FormatPreferences.Opt... opts)	Add option flags to these preferences.
void	clearIndentAbsolute(FormatPreferences.Indentation indentation)	Clear absolute indentation for the given context.
int	getIndent(FormatPreferences.Indentation indentation)	Get the configured indentation for the given context.
int	getLineLength()	Get the configured line length.
FormatPreferences.SpaceType	getSpaceType(FormatPreferences.Space space)	Get the spacing type for a given space context.
FormatPreferences.WrappingMode	getWrapMode(FormatPreferences.Wrapping wrapping)	Get the wrapping mode for the given wrapping context.
boolean	hasOption(FormatPreferences.Opt opt)	Determine whether the given option flag is set on these preferences.
boolean	isIndentAbsolute(FormatPreferences.Indentation indentation)	Determine whether the indentation for the given context is absolute or relative.
void	removeOption(FormatPreferences.Opt... opts)	Remove option flags from these preferences.
void	setAllSpaceTypes(FormatPreferences.SpaceType toType, FormatPreferences.Space... spaces)	Set several space contexts to the same spacing type.
int	setIndent(FormatPreferences.Indentation indentation, int value)	Set the configured indentation for the given context.
void	setIndentAbsolute(FormatPreferences.Indentation indentation)	Set absolute indentation for the given context.
FormatPreferences.SpaceType	setSpaceType(FormatPreferences.Space space, FormatPreferences.SpaceType spaceType)	Set the spacing type for the given space context.
FormatPreferences.WrappingMode	setWrapMode(FormatPreferences.Wrapping wrapping, FormatPreferences.WrappingMode mode)	Set the wrapping mode for the given wrapping context.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatPreferences

public FormatPreferences()

Construct a new instance using default values.

FormatPreferences

public FormatPreferences(java.util.Properties properties)

Construct a new instance, mapping the given properties to the formatter configurations.

Parameters:

properties - the properties to map

FormatPreferences

public FormatPreferences(java.lang.ClassLoader classLoader)
                  throws java.io.IOException

Construct a new instance using a properties file loaded from the given class loader.

Parameters:

classLoader - the class loader

Throws:

java.io.IOException - if an error occurs while reading the properties

FormatPreferences

public FormatPreferences(javax.annotation.processing.Filer filer,
                         java.lang.String name)
                  throws java.io.IOException

Construct a new instance using a properties file loaded from the given annotation processing filer.

Parameters:

filer - the filer to read from

name - the name of the properties file to read

Throws:

java.io.IOException - if an error occurs while reading the properties

FormatPreferences

public FormatPreferences(javax.annotation.processing.Filer filer)
                  throws java.io.IOException

Construct a new instance using a properties file loaded from the given annotation processing filer.

Parameters:

filer - the filer to read from

Throws:

java.io.IOException - if an error occurs while reading the properties

FormatPreferences

public FormatPreferences(java.io.File file)
                  throws java.io.IOException

Construct a new instance using a properties file loaded from the given file name.

Parameters:

file - the name of the properties file to read

Throws:

java.io.IOException - if an error occurs while reading the properties

FormatPreferences

public FormatPreferences(java.io.InputStream inputStream)
                  throws java.io.IOException

Construct a new instance using a properties read from the given stream.

Parameters:

inputStream - the stream to read properties from

Throws:

java.io.IOException - if an error occurs while reading the properties

FormatPreferences

public FormatPreferences(java.io.Reader reader)
                  throws java.io.IOException

Construct a new instance using a properties read from the given stream.

Parameters:

reader - the stream to read properties from

Throws:

java.io.IOException - if an error occurs while reading the properties

Method Detail

getLineLength

public int getLineLength()

Get the configured line length.

Returns:

the configured line length

getIndent

public int getIndent(FormatPreferences.Indentation indentation)

Get the configured indentation for the given context.

Parameters:

indentation - the indentation context

Returns:

the indentation

setIndent

public int setIndent(FormatPreferences.Indentation indentation,
                     int value)

Set the configured indentation for the given context.

Parameters:

indentation - the indentation context

value - the indentation

Returns:

the previous indentation

isIndentAbsolute

public boolean isIndentAbsolute(FormatPreferences.Indentation indentation)

Determine whether the indentation for the given context is absolute or relative.

Parameters:

indentation - the indentation context

Returns:

true if absolute, false if relative

setIndentAbsolute

public void setIndentAbsolute(FormatPreferences.Indentation indentation)

Set absolute indentation for the given context.

Parameters:

indentation - the indentation context

clearIndentAbsolute

public void clearIndentAbsolute(FormatPreferences.Indentation indentation)

Clear absolute indentation for the given context.

Parameters:

indentation - the indentation context

setSpaceType

public FormatPreferences.SpaceType setSpaceType(FormatPreferences.Space space,
                                                FormatPreferences.SpaceType spaceType)

Set the spacing type for the given space context.

Parameters:

space - the space context

spaceType - the space type

Returns:

the previous space type

setAllSpaceTypes

public void setAllSpaceTypes(FormatPreferences.SpaceType toType,
                             FormatPreferences.Space... spaces)

Set several space contexts to the same spacing type.

Parameters:

toType - the type to set to

spaces - the space contexts

getSpaceType

public FormatPreferences.SpaceType getSpaceType(FormatPreferences.Space space)

Get the spacing type for a given space context.

Parameters:

space - the space context

Returns:

the spacing type

getWrapMode

public FormatPreferences.WrappingMode getWrapMode(FormatPreferences.Wrapping wrapping)

Get the wrapping mode for the given wrapping context.

Parameters:

wrapping - the wrapping context

Returns:

the current wrapping mode

setWrapMode

public FormatPreferences.WrappingMode setWrapMode(FormatPreferences.Wrapping wrapping,
                                                  FormatPreferences.WrappingMode mode)

Set the wrapping mode for the given wrapping context.

Parameters:

wrapping - the wrapping context

mode - the wrapping mode

Returns:

the previous wrapping mode

addOption

public void addOption(FormatPreferences.Opt... opts)

Add option flags to these preferences.

Parameters:

opts - the flags to add

removeOption

public void removeOption(FormatPreferences.Opt... opts)

Remove option flags from these preferences.

Parameters:

opts - the flags to remove

hasOption

public boolean hasOption(FormatPreferences.Opt opt)

Determine whether the given option flag is set on these preferences.

Parameters:

opt - the flag to check

Returns:

true if the flag is present, false if it is absent