Skip navigation links

oracle.jdeveloper.style
Interface CodingStyleOptions

public interface CodingStyleOptions

A set of Coding Style options and convenience methods for using those options.

Since:

10.1.3

See Also:

CodingStyleManager#getCodingStyleOptions(oracle.ide.addin.Context)

Field Summary

static int	BRACE_POSITION_NEXT_LINE Indicates that the brace should appear on next line after the declaration.
static int	BRACE_POSITION_SAME_LINE Indicates that the brace should appear on the same line as the declaration.
static int	MEMBER_CLASS Constant used to get the member order for an inner class.
static int	MEMBER_CONSTRUCTOR Constant used to get the member order for a constructor.
static int	MEMBER_FIELD_PACKAGE Constant used to get the member order for a package private field.
static int	MEMBER_FIELD_PACKAGE_STATIC Constant used to get the member order for a package private static field.
static int	MEMBER_FIELD_PRIVATE Constant used to get the member order for a private field.
static int	MEMBER_FIELD_PRIVATE_STATIC Constant used to get the member order for a private static field.
static int	MEMBER_FIELD_PROTECTED Constant used to get the member order for a protected field.
static int	MEMBER_FIELD_PROTECTED_STATIC Constant used to get the member order for a protected static field.
static int	MEMBER_FIELD_PUBLIC Constant used to get the member order for a public field.
static int	MEMBER_FIELD_PUBLIC_STATIC Constant used to get the member order for a public static field.
static int	MEMBER_METHOD Constant used to get the member order for a method.
static int	WRAP_ALWAYS Indicates that elements should always be wrapped.
static int	WRAP_IF_LONG Indicates that elements exceeding the line width should be wrapped.
static int	WRAP_NEVER Indicates that all elements should appear on the same line.

Method Summary

void	addCodingStyleOptionsListener(CodingStyleOptionsListener listener) Add a listener for changes to these options.
java.lang.String	format(java.lang.String input) Convenience method to format the given string according to these options.
int	getArrayBracePosition() Determines where the opening brace following an array declaration should appear.
int	getBlanklinesAfterImports() Determines the number of blank lines after the import list in a class.
int	getBlanklinesAfterLastMember() Determines the number of blank lines after the last member in a class.
int	getBlanklinesBeforeField() Determines the number of blank lines before a field declaration.
int	getBlanklinesBeforeFirstClass() Determines the number of blank lines before the first class declaration.
int	getBlanklinesBeforeFirstMember() Determines the number of blank lines before the first member in a class.
int	getBlanklinesBeforeMemberClass() Determines the number of blank lines before a member class.
int	getBlanklinesBeforeMethod() Determines the number of blank lines before a method declaration.
int	getBlanklinesEmptyAnonymous() Determines the number of blank lines to be placed in an empty anonymous class body.
int	getBlanklinesEmptyBlock() Determines the number of blank lines to be placed in an empty block.
int	getBlanklinesEmptyClass() Determines the number of blank lines to be placed in an emtpy class body.
int	getBlanklinesEmptyMethod() Determines the number of blank lines to be placed in an empty method.
int	getBlanklinesPreserved() Determines the number of blank lines that will be preserved if already present.
int	getBlockBracePosition() Determines where the opening brace for a control statement block should appear.
int	getClassBracePosition() Determines where the opening brace following a class declaration should appear.
java.lang.String	getFieldName(java.lang.String base) Convenience method to get a field name that obeys the naming conventions specified in these options.
java.lang.String	getFieldPrefix() Determines the prefix for fields.
java.lang.String	getFieldSuffix() Determines the suffix for fields.
boolean	getGroupImports() Determines whether imports will be grouped.
int	getGroupPackageDepth() Determines the number of common packages that will cause similar import statements to be grouped.
boolean	getImportInnerClasses() Determines whether inner classes are imported, or only their parent class.
boolean	getIndentBlockChildren() Determines whether block children should be indented.
char[]	getIndentChars(int level) Convenience method to get an array of characters to use for the given indention level.
boolean	getIndentClassMembers() Determines whether class members should be indented.
boolean	getIndentControlBlocks() Determines whether control blocks should be indented.
boolean	getIndentReplaceWithTabs() Determines whether leading spaces in a line should be replaced with tab characters.
int	getIndentSize() Determines how many spaces are used for each indention level.
boolean	getIndentSwitchCases() Determines whether switch cases should be indented.
java.lang.String	getLocalVariableName(java.lang.String base) Convenience method to get a local variable name that obeys the naming conventions specified in these options.
java.lang.String	getLocalVariablePrefix() Determines the local variable prefix.
java.lang.String	getLocalVariableSuffix() Determines the local variable suffix.
byte	getMemberOrder(int member) Get the relative order of the given Java member.
int	getMethodBracePosition() Determines where the opening brace following a method declaration should appear.
boolean	getNewlineCatch() Determines whether a catch should appear on a new line.
boolean	getNewlineElse() Determines whether an else clause should be placed on a new line.
boolean	getNewlineExtends() Determines whether an extends clause should be placed on a new line.
boolean	getNewlineFinally() Determines whether a finally should appear on a new line.
boolean	getNewlineImplements() Determines whether an implements clause should be placed on a new line.
boolean	getNewlineThrows() Determines whether a throws clause should be placed on a new line.
boolean	getNewlineWhile() Determines whether a while statement in a do-while should be placed on a new line.
java.lang.String	getParameterName(java.lang.String base) Convenience method to get a parameter name that obeys the naming conventions specified in these options.
java.lang.String	getParameterPrefix() Determines the prefix for parameters.
java.lang.String	getParameterSuffix() Determines the suffix for parameters.
SourcePreferences	getSourcePreferences() Get a SourcePreferences object configured with these options.
boolean	getSpaceAfterColon() Determines whether a space should be placed after the colon in a ternary expression or enhanced for loop.
boolean	getSpaceAfterComma() Determines whether a space should be placed after a comma.
boolean	getSpaceAfterKeyword() Determines whether a space should be placed between a keyword an opening brace or parenthesis.
boolean	getSpaceAfterQuestion() Determines whether a space should be placed after a question mark.
boolean	getSpaceAfterSemicolon() Determines whether a space should be placed after a semicolon.
boolean	getSpaceAfterTypecast() Determines whether a space should be placed after a typecast.
boolean	getSpaceAroundAssignment() Determines whether spaces should be placed before and after assigment operators.
boolean	getSpaceAroundBinaryOperator() Determines whether spaces should be placed before and after binary operators.
boolean	getSpaceBeforeArguments() Determines whether a space should be placed before an argument list.
boolean	getSpaceBeforeColon() Determines whether a space should be placed before the colon in a ternary expression or enhanced for loop.
boolean	getSpaceBeforeComma() Determines whether a space should be placed before a comma.
boolean	getSpaceBeforeOpenBrace() Determines whether a space should be placed before an open brace.
boolean	getSpaceBeforeParameters() Determines whether a space should be placed before a parameter list.
boolean	getSpaceBeforeQuestion() Determines whether a space should be placed before a question mark.
boolean	getSpaceBeforeSemicolon() Determines whether a space should be placed before a semicolon.
boolean	getSpaceWithinBrackets() Determines whether a space should be placed after an open bracket and before a close bracket.
boolean	getSpaceWithinParenthesis() Determines whether a space should be placed after an open parenthesis and before a close parenthesis.
java.lang.String	getStaticFieldName(java.lang.String base) Convenience method to get a static field name that obeys the naming conventions specified in these options.
java.lang.String	getStaticFieldPrefix() Determines the prefix for static fields.
java.lang.String	getStaticFieldSuffix() Determines the suffix for static fields.
int	getSwitchCaseBracePosition() Determines where the opening brace following a switch case should appear.
int	getTabSize() Get the number of spaces that will be replaced with a tab.
boolean	getUseWideImports() Determines whether wide imports are used.
boolean	getUseWideMemberImports() Determines whether wide static imports are used.
int	getWideImportMemberThreshold() Determines the number of members that must be imported from a given class before a wide import (.*) is used.
int	getWideImportThreshold() Determines the number of classes that must be imported from a given package before a wide import (.*) is used.
boolean	getWrapAlign() Determines whether to align wrapped lines with the first element.
int	getWrapArrayConstant() Determines the wrapping for array constants.
int	getWrapBinaryOperator() Determines the wrapping for binary and assigment operators.
int	getWrapDotChain() Determines the wrapping for method calls and dot references.
int	getWrapExtends() Determines the wrapping for extends and implements clauses.
int	getWrapForStatement() Determines the wrapping for for statements.
int	getWrapInvokeArguments() Determines the wrapping for argument lists.
int	getWrapLineWidth() Determines the width of a line, after which the line will be wrapped.
int	getWrapModifiers() Determines the wrapping for modifiers and annotations.
int	getWrapParameterList() Determines the wrapping for parameter lists.
int	getWrapTernaryExpression() Determines the wrapping for ternary expressions.
int	getWrapThrows() Determines the wrapping for throws clauses.
void	removeCodingStyleOptionsListener(CodingStyleOptionsListener listener) Add a listener for changes to these options.

Field Detail

BRACE_POSITION_SAME_LINE

static final int BRACE_POSITION_SAME_LINE

Indicates that the brace should appear on the same line as the declaration.

See Also:

Constant Field Values

BRACE_POSITION_NEXT_LINE

static final int BRACE_POSITION_NEXT_LINE

Indicates that the brace should appear on next line after the declaration.

See Also:

Constant Field Values

WRAP_NEVER

static final int WRAP_NEVER

Indicates that all elements should appear on the same line.

See Also:

Constant Field Values

WRAP_IF_LONG

static final int WRAP_IF_LONG

Indicates that elements exceeding the line width should be wrapped.

See Also:

Constant Field Values

WRAP_ALWAYS

static final int WRAP_ALWAYS

Indicates that elements should always be wrapped.

See Also:

Constant Field Values

MEMBER_FIELD_PUBLIC_STATIC

static final int MEMBER_FIELD_PUBLIC_STATIC

Constant used to get the member order for a public static field.

See Also:

Constant Field Values

MEMBER_FIELD_PROTECTED_STATIC

static final int MEMBER_FIELD_PROTECTED_STATIC

Constant used to get the member order for a protected static field.

See Also:

Constant Field Values

MEMBER_FIELD_PACKAGE_STATIC

static final int MEMBER_FIELD_PACKAGE_STATIC

Constant used to get the member order for a package private static field.

See Also:

Constant Field Values

MEMBER_FIELD_PRIVATE_STATIC

static final int MEMBER_FIELD_PRIVATE_STATIC

Constant used to get the member order for a private static field.

See Also:

Constant Field Values

MEMBER_FIELD_PUBLIC

static final int MEMBER_FIELD_PUBLIC

Constant used to get the member order for a public field.

See Also:

Constant Field Values

MEMBER_FIELD_PROTECTED

static final int MEMBER_FIELD_PROTECTED

Constant used to get the member order for a protected field.

See Also:

Constant Field Values

MEMBER_FIELD_PACKAGE

static final int MEMBER_FIELD_PACKAGE

Constant used to get the member order for a package private field.

See Also:

Constant Field Values

MEMBER_FIELD_PRIVATE

static final int MEMBER_FIELD_PRIVATE

Constant used to get the member order for a private field.

See Also:

Constant Field Values

MEMBER_CONSTRUCTOR

static final int MEMBER_CONSTRUCTOR

Constant used to get the member order for a constructor.

See Also:

Constant Field Values

MEMBER_METHOD

static final int MEMBER_METHOD

Constant used to get the member order for a method.

See Also:

Constant Field Values

MEMBER_CLASS

static final int MEMBER_CLASS

Constant used to get the member order for an inner class.

See Also:

Constant Field Values

Method Detail

addCodingStyleOptionsListener

void addCodingStyleOptionsListener(CodingStyleOptionsListener listener)

Add a listener for changes to these options.

Parameters:

listener - listener to be added

removeCodingStyleOptionsListener

void removeCodingStyleOptionsListener(CodingStyleOptionsListener listener)

Add a listener for changes to these options.

Parameters:

listener - listener to be added

getSourcePreferences

SourcePreferences getSourcePreferences()

Get a SourcePreferences object configured with these options.

Returns:

the source preferences

getIndentSize

int getIndentSize()

Determines how many spaces are used for each indention level.

Returns:

the number of spaces in an indention level

getIndentReplaceWithTabs

boolean getIndentReplaceWithTabs()

Determines whether leading spaces in a line should be replaced with tab characters. The value returned by getTabSize() will determine how many spaces are replaced with tab.

Returns:

true if spaces should be replaced with tabs, false otherwise

getTabSize

int getTabSize()

Get the number of spaces that will be replaced with a tab. This should only be used if getIndentReplaceWithTabs() returns true.

Returns:

the number of spaces to replace with a tab

getIndentClassMembers

boolean getIndentClassMembers()

Determines whether class members should be indented.

Returns:

true if class members should be indented, false otherwise

getIndentControlBlocks

boolean getIndentControlBlocks()

Determines whether control blocks should be indented.

Returns:

true if control blocks should be indented, false otherwise

getIndentBlockChildren

boolean getIndentBlockChildren()

Determines whether block children should be indented.

Returns:

true if block children should be indented, false otherwise

getIndentSwitchCases

boolean getIndentSwitchCases()

Determines whether switch cases should be indented.

Returns:

true if switch cases should be indented, false otherwise

getBlanklinesPreserved

int getBlanklinesPreserved()

Determines the number of blank lines that will be preserved if already present.

Returns:

the number of blank lines to preserve

getBlanklinesAfterImports

int getBlanklinesAfterImports()

Determines the number of blank lines after the import list in a class. This option should be ignored if there are no imports.

Returns:

the number of blank lines after the import list

getBlanklinesBeforeFirstClass

int getBlanklinesBeforeFirstClass()

Determines the number of blank lines before the first class declaration.

Returns:

the number of blank lines before a class declaration

getBlanklinesBeforeFirstMember

int getBlanklinesBeforeFirstMember()

Determines the number of blank lines before the first member in a class.

Returns:

the number of blank lines before the first member

getBlanklinesAfterLastMember

int getBlanklinesAfterLastMember()

Determines the number of blank lines after the last member in a class.

Returns:

the number of blank lines after the last member

getBlanklinesBeforeField

int getBlanklinesBeforeField()

Determines the number of blank lines before a field declaration.

Returns:

the number of blank lines before a field declaration

getBlanklinesBeforeMethod

int getBlanklinesBeforeMethod()

Determines the number of blank lines before a method declaration.

Returns:

the number of blank lines before a method declaration

getBlanklinesBeforeMemberClass

int getBlanklinesBeforeMemberClass()

Determines the number of blank lines before a member class.

Returns:

the number of blank lines before a member class

getBlanklinesEmptyClass

int getBlanklinesEmptyClass()

Determines the number of blank lines to be placed in an emtpy class body.

Returns:

the number of blank lines in an empty class body

getBlanklinesEmptyAnonymous

int getBlanklinesEmptyAnonymous()

Determines the number of blank lines to be placed in an empty anonymous class body.

Returns:

the number of blank lines in an empty anonymous class body

getBlanklinesEmptyMethod

int getBlanklinesEmptyMethod()

Determines the number of blank lines to be placed in an empty method.

Returns:

the number of blank lines in an empty method

getBlanklinesEmptyBlock

int getBlanklinesEmptyBlock()

Determines the number of blank lines to be placed in an empty block.

Returns:

the number of blank lines in an empty block

getNewlineExtends

boolean getNewlineExtends()

Determines whether an extends clause should be placed on a new line.

Returns:

true if an extends clause should appear on a new line, false otherwise

getNewlineImplements

boolean getNewlineImplements()

Determines whether an implements clause should be placed on a new line.

Returns:

true if an implements clause should appear on a new line, false otherwise

getNewlineThrows

boolean getNewlineThrows()

Determines whether a throws clause should be placed on a new line.

Returns:

true if a throws clause should appear on a new line, false otherwise

getNewlineElse

boolean getNewlineElse()

Determines whether an else clause should be placed on a new line.

Returns:

true if an else clause should appear on a new line, false otherwise

getNewlineWhile

boolean getNewlineWhile()

Determines whether a while statement in a do-while should be placed on a new line.

Returns:

true if a while statement should appear on a new line, false otherwise

getNewlineCatch

boolean getNewlineCatch()

Determines whether a catch should appear on a new line.

Returns:

true if a catch should appear on a new line, false otherwise

getNewlineFinally

boolean getNewlineFinally()

Determines whether a finally should appear on a new line.

Returns:

true if a finally should appear on a new line, false otherwise

getSpaceBeforeComma

boolean getSpaceBeforeComma()

Determines whether a space should be placed before a comma.

Returns:

true if a space should be placed before a comma, false otherwise

getSpaceAfterComma

boolean getSpaceAfterComma()

Determines whether a space should be placed after a comma.

Returns:

true if a space should be placed after a comma, false otherwise

getSpaceBeforeSemicolon

boolean getSpaceBeforeSemicolon()

Determines whether a space should be placed before a semicolon.

Returns:

true if a space should be placed before a semicolon, false otherwise

getSpaceAfterSemicolon

boolean getSpaceAfterSemicolon()

Determines whether a space should be placed after a semicolon.

Returns:

true if a space should be placed after a semicolon, false otherwise

getSpaceBeforeQuestion

boolean getSpaceBeforeQuestion()

Determines whether a space should be placed before a question mark.

Returns:

true if a space should be placed before a question mark, false otherwise

getSpaceAfterQuestion

boolean getSpaceAfterQuestion()

Determines whether a space should be placed after a question mark.

Returns:

true if a space should be placed after a question mark, false otherwise

getSpaceBeforeColon

boolean getSpaceBeforeColon()

Determines whether a space should be placed before the colon in a ternary expression or enhanced for loop.

Returns:

true if a space should be placed before the colon in a ternary expression or enhanced for loop, false otherwise

getSpaceAfterColon

boolean getSpaceAfterColon()

Determines whether a space should be placed after the colon in a ternary expression or enhanced for loop.

Returns:

true if a space should be placed after the colon in a ternary expression or enhanced for loop, false otherwise

getSpaceAfterTypecast

boolean getSpaceAfterTypecast()

Determines whether a space should be placed after a typecast.

Returns:

true if a space should be placed after a typecast, false otherwise

getSpaceBeforeArguments

boolean getSpaceBeforeArguments()

Determines whether a space should be placed before an argument list.

Returns:

true if a space should be placed before an argument list, false otherwise

getSpaceBeforeParameters

boolean getSpaceBeforeParameters()

Determines whether a space should be placed before a parameter list.

Returns:

true if a space should be placed before a parameter list, false otherwise

getSpaceAfterKeyword

boolean getSpaceAfterKeyword()

Determines whether a space should be placed between a keyword an opening brace or parenthesis. Applies to keywords such as catch, do, for, if, switch, synchronized, and while.

Returns:

true if a space should be placed before a keyword, false otherwise

getSpaceAroundAssignment

boolean getSpaceAroundAssignment()

Determines whether spaces should be placed before and after assigment operators. Assignment operators are: = += -= *= /= %= &= |= ^= <<= >>= >>>=

Returns:

true if a space should be placed around assigment operators, false otherwise

getSpaceAroundBinaryOperator

boolean getSpaceAroundBinaryOperator()

Determines whether spaces should be placed before and after binary operators. Binary operators are: == != < <= > >= + - * / % && || & | ^ << >> >>>

Returns:

true if a space should be placed around binary operators, false otherwise

getSpaceWithinParenthesis

boolean getSpaceWithinParenthesis()

Determines whether a space should be placed after an open parenthesis and before a close parenthesis. This option should be ignored if the parenthesis are empty.

Returns:

true if a space should be placed inside parenthesis, false otherwise

getSpaceWithinBrackets

boolean getSpaceWithinBrackets()

Determines whether a space should be placed after an open bracket and before a close bracket. This option should be ignored if the brackets are empty.

Returns:

true if a space should be placed inside brackets, false otherwise

getSpaceBeforeOpenBrace

boolean getSpaceBeforeOpenBrace()

Determines whether a space should be placed before an open brace.

Returns:

true if a space should be placed before an open brace, false otherwise

getClassBracePosition

int getClassBracePosition()

Determines where the opening brace following a class declaration should appear. Possible values are BRACE_POSITION_SAME_LINE and BRACE_POSITION_NEXT_LINE.

getMethodBracePosition

int getMethodBracePosition()

Determines where the opening brace following a method declaration should appear. Possible values are BRACE_POSITION_SAME_LINE and BRACE_POSITION_NEXT_LINE.

getBlockBracePosition

int getBlockBracePosition()

Determines where the opening brace for a control statement block should appear. Possible values are BRACE_POSITION_SAME_LINE and BRACE_POSITION_NEXT_LINE.

getArrayBracePosition

int getArrayBracePosition()

Determines where the opening brace following an array declaration should appear. Possible values are BRACE_POSITION_SAME_LINE and BRACE_POSITION_NEXT_LINE.

getSwitchCaseBracePosition

int getSwitchCaseBracePosition()

Determines where the opening brace following a switch case should appear. Possible values are BRACE_POSITION_SAME_LINE and BRACE_POSITION_NEXT_LINE.

getWrapLineWidth

int getWrapLineWidth()

Determines the width of a line, after which the line will be wrapped.

Returns:

the wrapping line width

getWrapAlign

boolean getWrapAlign()

Determines whether to align wrapped lines with the first element.

Returns:

true if wrapped lines should be aligned with the first element, false if they should be indented

getWrapModifiers

int getWrapModifiers()

Determines the wrapping for modifiers and annotations. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for modifiers and annotations

getWrapExtends

int getWrapExtends()

Determines the wrapping for extends and implements clauses. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for extends and implements clauses

getWrapThrows

int getWrapThrows()

Determines the wrapping for throws clauses. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for throws clauses

getWrapParameterList

int getWrapParameterList()

Determines the wrapping for parameter lists. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for parameter lists.

getWrapDotChain

int getWrapDotChain()

Determines the wrapping for method calls and dot references. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for dot chains

getWrapForStatement

int getWrapForStatement()

Determines the wrapping for for statements. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for for statements

getWrapBinaryOperator

int getWrapBinaryOperator()

Determines the wrapping for binary and assigment operators. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for binary and assignment operators

getWrapTernaryExpression

int getWrapTernaryExpression()

Determines the wrapping for ternary expressions. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for ternary expressions

getWrapArrayConstant

int getWrapArrayConstant()

Determines the wrapping for array constants. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for array constants

getWrapInvokeArguments

int getWrapInvokeArguments()

Determines the wrapping for argument lists. Possible values are WRAP_ALWAYS, WRAP_NEVER, and WRAP_IF_LONG.

Returns:

the wrapping for argument lists.

getGroupImports

boolean getGroupImports()

Determines whether imports will be grouped.

Returns:

true if imports are grouped, false otherwise

See Also:

getGroupPackageDepth()

getGroupPackageDepth

int getGroupPackageDepth()

Determines the number of common packages that will cause similar import statements to be grouped. A return value of 0 means that similar packages are not grouped.

Returns:

the number of common packages used to group imports

getImportInnerClasses

boolean getImportInnerClasses()

Determines whether inner classes are imported, or only their parent class.

Returns:

true if inner classes are imported, false otherwise

getUseWideImports

boolean getUseWideImports()

Determines whether wide imports are used. If wide imports are used, the threshold returned by getWideImportThreshold() will determine how many narrow imports are allowed before a wide import is used.

Returns:

true if wide imports are used, false if all imports are narrow imports

getUseWideMemberImports

boolean getUseWideMemberImports()

Determines whether wide static imports are used. If wide static imports are used, the threshold returned by getWideImportMemberThreshold() will determine how many narrow static imports are allowed before a wide static import is used.

Returns:

true if wide static imports are used, false if all imports are narrow static imports

getWideImportThreshold

int getWideImportThreshold()

Determines the number of classes that must be imported from a given package before a wide import (.*) is used. A value of 0 or 1 means all imports are wide. This value is ignored if getUseWideImports() returns false.

Returns:

the threshold for wide type imports

getWideImportMemberThreshold

int getWideImportMemberThreshold()

Determines the number of members that must be imported from a given class before a wide import (.*) is used. A value of 0 or 1 means all imports are wide. This value is ignored if getUseWideImports() returns false.

Returns:

the threshold for wide member imports

getFieldPrefix

java.lang.String getFieldPrefix()

Determines the prefix for fields.

Returns:

the field prefix, or null if not present

getFieldSuffix

java.lang.String getFieldSuffix()

Determines the suffix for fields.

Returns:

the field suffix, or null if not present

getStaticFieldPrefix

java.lang.String getStaticFieldPrefix()

Determines the prefix for static fields.

Returns:

the static field prefix, or null if not present

getStaticFieldSuffix

java.lang.String getStaticFieldSuffix()

Determines the suffix for static fields.

Returns:

the static field suffix, or null if not present

getParameterPrefix

java.lang.String getParameterPrefix()

Determines the prefix for parameters.

Returns:

the parameter prefix, or null if not present

getParameterSuffix

java.lang.String getParameterSuffix()

Determines the suffix for parameters.

Returns:

the parameter suffix, or null if not present

getLocalVariablePrefix

java.lang.String getLocalVariablePrefix()

Determines the local variable prefix.

Returns:

the prefix for local variables, or null if not present

getLocalVariableSuffix

java.lang.String getLocalVariableSuffix()

Determines the local variable suffix.

Returns:

the local variable suffix, or null if not present

getIndentChars

char[] getIndentChars(int level)

Convenience method to get an array of characters to use for the given indention level. The array will contain the appropriate number of tabs and spaces to be used for that indention level.

Returns:

an array of tab and space characters to use for indention

See Also:

getIndentSize(), getIndentReplaceWithTabs(), getTabSize()

format

java.lang.String format(java.lang.String input)

Convenience method to format the given string according to these options.

Parameters:

input - the input string

Returns:

the formatted string

getFieldName

java.lang.String getFieldName(java.lang.String base)

Convenience method to get a field name that obeys the naming conventions specified in these options.

Parameters:

base - the base name

Returns:

the field name

getStaticFieldName

java.lang.String getStaticFieldName(java.lang.String base)

Convenience method to get a static field name that obeys the naming conventions specified in these options.

Parameters:

base - the base name

Returns:

the static field name

getParameterName

java.lang.String getParameterName(java.lang.String base)

Convenience method to get a parameter name that obeys the naming conventions specified in these options.

Parameters:

base - the base name

Returns:

the parameter name

getLocalVariableName

java.lang.String getLocalVariableName(java.lang.String base)

Convenience method to get a local variable name that obeys the naming conventions specified in these options.

Parameters:

base - the base name

Returns:

the local variable name

getMemberOrder

byte getMemberOrder(int member)

Get the relative order of the given Java member. The values returned for different members can be compared to determine their relative order.

Parameters:

member - the Java member

Returns:

the relative order value

See Also:

MEMBER_FIELD_PUBLIC_STATIC, MEMBER_FIELD_PROTECTED_STATIC, MEMBER_FIELD_PACKAGE_STATIC, MEMBER_FIELD_PRIVATE_STATIC, MEMBER_FIELD_PUBLIC, MEMBER_FIELD_PROTECTED, MEMBER_FIELD_PACKAGE, MEMBER_FIELD_PRIVATE, MEMBER_CONSTRUCTOR, MEMBER_METHOD, MEMBER_CLASS

Skip navigation links