Package com.intellij.psi.codeStyle

Class JavaCodeStyleSettings

java.lang.Object

com.intellij.psi.codeStyle.CustomCodeStyleSettings

com.intellij.psi.codeStyle.JavaCodeStyleSettings

All Implemented Interfaces:

ImportsLayoutSettings, java.lang.Cloneable

public class JavaCodeStyleSettings
extends CustomCodeStyleSettings
implements ImportsLayoutSettings

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ALIGN_MULTILINE_ANNOTATION_PARAMETERS
boolean	ALIGN_MULTILINE_RECORDS
boolean	ALIGN_MULTILINE_TEXT_BLOCKS
int	ANNOTATION_PARAMETER_WRAP
int	BLANK_LINES_AROUND_INITIALIZER
int	CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND
int	CLASS_NAMES_IN_JAVADOC
boolean	DO_NOT_WRAP_AFTER_SINGLE_ANNOTATION
boolean	ENABLE_JAVADOC_FORMATTING
java.lang.String	FIELD_NAME_PREFIX
java.lang.String	FIELD_NAME_SUFFIX
static int	FULLY_QUALIFY_NAMES_ALWAYS
static int	FULLY_QUALIFY_NAMES_IF_NOT_IMPORTED
boolean	GENERATE_FINAL_LOCALS
boolean	GENERATE_FINAL_PARAMETERS
PackageEntryTable	IMPORT_LAYOUT_TABLE
boolean	INSERT_INNER_CLASS_IMPORTS
boolean	INSERT_OVERRIDE_ANNOTATION
boolean	JD_ADD_BLANK_AFTER_DESCRIPTION
boolean	JD_ADD_BLANK_AFTER_PARM_COMMENTS
boolean	JD_ADD_BLANK_AFTER_RETURN
boolean	JD_ALIGN_EXCEPTION_COMMENTS
boolean	JD_ALIGN_PARAM_COMMENTS
boolean	JD_DO_NOT_WRAP_ONE_LINE_COMMENTS
boolean	JD_INDENT_ON_CONTINUATION
boolean	JD_KEEP_EMPTY_EXCEPTION
boolean	JD_KEEP_EMPTY_LINES
boolean	JD_KEEP_EMPTY_PARAMETER
boolean	JD_KEEP_EMPTY_RETURN
boolean	JD_KEEP_INVALID_TAGS
boolean	JD_LEADING_ASTERISKS_ARE_ENABLED
boolean	JD_P_AT_EMPTY_LINES
boolean	JD_PARAM_DESCRIPTION_ON_NEW_LINE
boolean	JD_PRESERVE_LINE_FEEDS
boolean	JD_USE_THROWS_NOT_EXCEPTION
boolean	LAYOUT_STATIC_IMPORTS_SEPARATELY
java.lang.String	LOCAL_VARIABLE_NAME_PREFIX
java.lang.String	LOCAL_VARIABLE_NAME_SUFFIX
int	NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND
boolean	NEW_LINE_AFTER_LPAREN_IN_RECORD_HEADER
PackageEntryTable	PACKAGES_TO_USE_IMPORT_ON_DEMAND
java.lang.String	PARAMETER_NAME_PREFIX
java.lang.String	PARAMETER_NAME_SUFFIX
boolean	PREFER_LONGER_NAMES
int	RECORD_COMPONENTS_WRAP
boolean	REPEAT_SYNCHRONIZED
boolean	REPLACE_CAST Deprecated. Use REPLACE_INSTANCEOF_AND_CAST
boolean	REPLACE_INSTANCEOF Deprecated. Use REPLACE_INSTANCEOF_AND_CAST
boolean	REPLACE_INSTANCEOF_AND_CAST
boolean	REPLACE_NULL_CHECK
boolean	REPLACE_SUM
boolean	RPAREN_ON_NEW_LINE_IN_RECORD_HEADER
static int	SHORTEN_NAMES_ALWAYS_AND_ADD_IMPORT
boolean	SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENT
boolean	SPACE_AROUND_TYPE_BOUNDS_IN_TYPE_PARAMETERS
boolean	SPACE_BEFORE_COLON_IN_FOREACH
boolean	SPACE_BEFORE_OPENING_ANGLE_BRACKET_IN_TYPE_PARAMETER
boolean	SPACE_INSIDE_ONE_LINE_ENUM_BRACES
boolean	SPACES_WITHIN_ANGLE_BRACKETS
java.lang.String	STATIC_FIELD_NAME_PREFIX
java.lang.String	STATIC_FIELD_NAME_SUFFIX
java.lang.String	SUBCLASS_NAME_PREFIX
java.lang.String	SUBCLASS_NAME_SUFFIX
java.lang.String	TEST_NAME_PREFIX
java.lang.String	TEST_NAME_SUFFIX
boolean	USE_EXTERNAL_ANNOTATIONS
boolean	USE_FQ_CLASS_NAMES
boolean	USE_SINGLE_CLASS_IMPORTS
java.lang.String	VISIBILITY

Constructor Summary

Constructors

Constructor and Description
JavaCodeStyleSettings(CodeStyleSettings container)

Method Summary

Modifier and Type	Method and Description
protected void	afterLoaded() Fired when settings just loaded.
java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
int	getClassCountToUseImportOnDemand()
java.util.List<java.lang.String>	getDoNotImportInner()
PackageEntryTable	getImportLayoutTable()
static JavaCodeStyleSettings	getInstance(Project project) For production code use getInstance(PsiFile)
static JavaCodeStyleSettings	getInstance(PsiFile file)
java.util.List<java.lang.String>	getKnownTagNames() in case settings save additional top-level tags, list the list of them to prevent serializer to treat such tag as unknown settings.
int	getNamesCountToUseImportOnDemand()
PackageEntryTable	getPackagesToUseImportOnDemand()
java.util.List<java.lang.String>	getRepeatAnnotations()
protected void	importLegacySettings(CodeStyleSettings rootSettings) For compatibility with old code style settings stored in CodeStyleSettings.
boolean	isGenerateFinalLocals()
boolean	isGenerateFinalParameters()
boolean	isInsertInnerClassImports()
boolean	isInsertInnerClassImportsFor(java.lang.String className)
boolean	isLayoutStaticImportsSeparately()
boolean	isUseFqClassNames()
boolean	isUseSingleClassImports()
void	readExternal(Element parentElement)
void	setClassCountToUseImportOnDemand(int value)
void	setDoNotImportInner(java.util.List<java.lang.String> doNotImportInner)
void	setInsertInnerClassImports(boolean value)
void	setLayoutStaticImportsSeparately(boolean value)
void	setNamesCountToUseImportOnDemand(int value)
void	setRepeatAnnotations(java.util.List<java.lang.String> repeatAnnotations)
void	setUseFqClassNames(boolean value)
void	setUseSingleClassImports(boolean value)
boolean	useFqNamesInJavadocAlways()
void	writeExternal(Element parentElement, CustomCodeStyleSettings parentSettings)

Methods inherited from class com.intellij.psi.codeStyle.CustomCodeStyleSettings

beforeLoading, getContainer, getTagName

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME_PREFIX

public java.lang.String FIELD_NAME_PREFIX

STATIC_FIELD_NAME_PREFIX

public java.lang.String STATIC_FIELD_NAME_PREFIX

PARAMETER_NAME_PREFIX

public java.lang.String PARAMETER_NAME_PREFIX

LOCAL_VARIABLE_NAME_PREFIX

public java.lang.String LOCAL_VARIABLE_NAME_PREFIX

TEST_NAME_PREFIX

public java.lang.String TEST_NAME_PREFIX

SUBCLASS_NAME_PREFIX

public java.lang.String SUBCLASS_NAME_PREFIX

FIELD_NAME_SUFFIX

public java.lang.String FIELD_NAME_SUFFIX

STATIC_FIELD_NAME_SUFFIX

public java.lang.String STATIC_FIELD_NAME_SUFFIX

PARAMETER_NAME_SUFFIX

public java.lang.String PARAMETER_NAME_SUFFIX

LOCAL_VARIABLE_NAME_SUFFIX

public java.lang.String LOCAL_VARIABLE_NAME_SUFFIX

TEST_NAME_SUFFIX

public java.lang.String TEST_NAME_SUFFIX

SUBCLASS_NAME_SUFFIX

public java.lang.String SUBCLASS_NAME_SUFFIX

PREFER_LONGER_NAMES

public boolean PREFER_LONGER_NAMES

GENERATE_FINAL_LOCALS

public boolean GENERATE_FINAL_LOCALS

GENERATE_FINAL_PARAMETERS

public boolean GENERATE_FINAL_PARAMETERS

VISIBILITY

public java.lang.String VISIBILITY

USE_EXTERNAL_ANNOTATIONS

public boolean USE_EXTERNAL_ANNOTATIONS

INSERT_OVERRIDE_ANNOTATION

public boolean INSERT_OVERRIDE_ANNOTATION

REPEAT_SYNCHRONIZED

public boolean REPEAT_SYNCHRONIZED

REPLACE_INSTANCEOF

@Deprecated
public boolean REPLACE_INSTANCEOF

Deprecated. Use REPLACE_INSTANCEOF_AND_CAST

REPLACE_CAST

@Deprecated
public boolean REPLACE_CAST

Deprecated. Use REPLACE_INSTANCEOF_AND_CAST

REPLACE_INSTANCEOF_AND_CAST

public boolean REPLACE_INSTANCEOF_AND_CAST

REPLACE_NULL_CHECK

public boolean REPLACE_NULL_CHECK

REPLACE_SUM

public boolean REPLACE_SUM

SPACES_WITHIN_ANGLE_BRACKETS

public boolean SPACES_WITHIN_ANGLE_BRACKETS

SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENT

public boolean SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENT

SPACE_BEFORE_OPENING_ANGLE_BRACKET_IN_TYPE_PARAMETER

public boolean SPACE_BEFORE_OPENING_ANGLE_BRACKET_IN_TYPE_PARAMETER

SPACE_AROUND_TYPE_BOUNDS_IN_TYPE_PARAMETERS

public boolean SPACE_AROUND_TYPE_BOUNDS_IN_TYPE_PARAMETERS

DO_NOT_WRAP_AFTER_SINGLE_ANNOTATION

public boolean DO_NOT_WRAP_AFTER_SINGLE_ANNOTATION

ANNOTATION_PARAMETER_WRAP

public int ANNOTATION_PARAMETER_WRAP

ALIGN_MULTILINE_ANNOTATION_PARAMETERS

public boolean ALIGN_MULTILINE_ANNOTATION_PARAMETERS

ALIGN_MULTILINE_TEXT_BLOCKS

public boolean ALIGN_MULTILINE_TEXT_BLOCKS

BLANK_LINES_AROUND_INITIALIZER

public int BLANK_LINES_AROUND_INITIALIZER

FULLY_QUALIFY_NAMES_IF_NOT_IMPORTED

public static final int FULLY_QUALIFY_NAMES_IF_NOT_IMPORTED

See Also:

Constant Field Values

FULLY_QUALIFY_NAMES_ALWAYS

public static final int FULLY_QUALIFY_NAMES_ALWAYS

See Also:

Constant Field Values

SHORTEN_NAMES_ALWAYS_AND_ADD_IMPORT

public static final int SHORTEN_NAMES_ALWAYS_AND_ADD_IMPORT

See Also:

Constant Field Values

CLASS_NAMES_IN_JAVADOC

public int CLASS_NAMES_IN_JAVADOC

SPACE_BEFORE_COLON_IN_FOREACH

public boolean SPACE_BEFORE_COLON_IN_FOREACH

SPACE_INSIDE_ONE_LINE_ENUM_BRACES

public boolean SPACE_INSIDE_ONE_LINE_ENUM_BRACES

LAYOUT_STATIC_IMPORTS_SEPARATELY

public boolean LAYOUT_STATIC_IMPORTS_SEPARATELY

USE_FQ_CLASS_NAMES

public boolean USE_FQ_CLASS_NAMES

USE_SINGLE_CLASS_IMPORTS

public boolean USE_SINGLE_CLASS_IMPORTS

INSERT_INNER_CLASS_IMPORTS

public boolean INSERT_INNER_CLASS_IMPORTS

CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND

public int CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND

NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND

public int NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND

PACKAGES_TO_USE_IMPORT_ON_DEMAND

public PackageEntryTable PACKAGES_TO_USE_IMPORT_ON_DEMAND

IMPORT_LAYOUT_TABLE

public PackageEntryTable IMPORT_LAYOUT_TABLE

RECORD_COMPONENTS_WRAP

public int RECORD_COMPONENTS_WRAP

ALIGN_MULTILINE_RECORDS

public boolean ALIGN_MULTILINE_RECORDS

NEW_LINE_AFTER_LPAREN_IN_RECORD_HEADER

public boolean NEW_LINE_AFTER_LPAREN_IN_RECORD_HEADER

RPAREN_ON_NEW_LINE_IN_RECORD_HEADER

public boolean RPAREN_ON_NEW_LINE_IN_RECORD_HEADER

ENABLE_JAVADOC_FORMATTING

public boolean ENABLE_JAVADOC_FORMATTING

JD_ALIGN_PARAM_COMMENTS

public boolean JD_ALIGN_PARAM_COMMENTS

JD_ALIGN_EXCEPTION_COMMENTS

public boolean JD_ALIGN_EXCEPTION_COMMENTS

JD_ADD_BLANK_AFTER_PARM_COMMENTS

public boolean JD_ADD_BLANK_AFTER_PARM_COMMENTS

JD_ADD_BLANK_AFTER_RETURN

public boolean JD_ADD_BLANK_AFTER_RETURN

JD_ADD_BLANK_AFTER_DESCRIPTION

public boolean JD_ADD_BLANK_AFTER_DESCRIPTION

JD_P_AT_EMPTY_LINES

public boolean JD_P_AT_EMPTY_LINES

JD_KEEP_INVALID_TAGS

public boolean JD_KEEP_INVALID_TAGS

JD_KEEP_EMPTY_LINES

public boolean JD_KEEP_EMPTY_LINES

JD_DO_NOT_WRAP_ONE_LINE_COMMENTS

public boolean JD_DO_NOT_WRAP_ONE_LINE_COMMENTS

JD_USE_THROWS_NOT_EXCEPTION

public boolean JD_USE_THROWS_NOT_EXCEPTION

JD_KEEP_EMPTY_PARAMETER

public boolean JD_KEEP_EMPTY_PARAMETER

JD_KEEP_EMPTY_EXCEPTION

public boolean JD_KEEP_EMPTY_EXCEPTION

JD_KEEP_EMPTY_RETURN

public boolean JD_KEEP_EMPTY_RETURN

JD_LEADING_ASTERISKS_ARE_ENABLED

public boolean JD_LEADING_ASTERISKS_ARE_ENABLED

JD_PRESERVE_LINE_FEEDS

public boolean JD_PRESERVE_LINE_FEEDS

JD_PARAM_DESCRIPTION_ON_NEW_LINE

public boolean JD_PARAM_DESCRIPTION_ON_NEW_LINE

JD_INDENT_ON_CONTINUATION

public boolean JD_INDENT_ON_CONTINUATION

Constructor Detail

JavaCodeStyleSettings

public JavaCodeStyleSettings(CodeStyleSettings container)

Method Detail

getRepeatAnnotations

public java.util.List<java.lang.String> getRepeatAnnotations()

setRepeatAnnotations

public void setRepeatAnnotations(java.util.List<java.lang.String> repeatAnnotations)

getDoNotImportInner

public java.util.List<java.lang.String> getDoNotImportInner()

setDoNotImportInner

public void setDoNotImportInner(java.util.List<java.lang.String> doNotImportInner)

useFqNamesInJavadocAlways

public boolean useFqNamesInJavadocAlways()

isLayoutStaticImportsSeparately

public boolean isLayoutStaticImportsSeparately()

Specified by:

isLayoutStaticImportsSeparately in interface ImportsLayoutSettings

setLayoutStaticImportsSeparately

public void setLayoutStaticImportsSeparately(boolean value)

Specified by:

setLayoutStaticImportsSeparately in interface ImportsLayoutSettings

getNamesCountToUseImportOnDemand

public int getNamesCountToUseImportOnDemand()

Specified by:

getNamesCountToUseImportOnDemand in interface ImportsLayoutSettings

setNamesCountToUseImportOnDemand

public void setNamesCountToUseImportOnDemand(int value)

Specified by:

setNamesCountToUseImportOnDemand in interface ImportsLayoutSettings

getClassCountToUseImportOnDemand

public int getClassCountToUseImportOnDemand()

Specified by:

getClassCountToUseImportOnDemand in interface ImportsLayoutSettings

setClassCountToUseImportOnDemand

public void setClassCountToUseImportOnDemand(int value)

Specified by:

setClassCountToUseImportOnDemand in interface ImportsLayoutSettings

isInsertInnerClassImports

public boolean isInsertInnerClassImports()

Specified by:

isInsertInnerClassImports in interface ImportsLayoutSettings

setInsertInnerClassImports

public void setInsertInnerClassImports(boolean value)

Specified by:

setInsertInnerClassImports in interface ImportsLayoutSettings

isInsertInnerClassImportsFor

public boolean isInsertInnerClassImportsFor(java.lang.String className)

isUseSingleClassImports

public boolean isUseSingleClassImports()

Specified by:

isUseSingleClassImports in interface ImportsLayoutSettings

setUseSingleClassImports

public void setUseSingleClassImports(boolean value)

Specified by:

setUseSingleClassImports in interface ImportsLayoutSettings

isUseFqClassNames

public boolean isUseFqClassNames()

Specified by:

isUseFqClassNames in interface ImportsLayoutSettings

setUseFqClassNames

public void setUseFqClassNames(boolean value)

Specified by:

setUseFqClassNames in interface ImportsLayoutSettings

getImportLayoutTable

public PackageEntryTable getImportLayoutTable()

Specified by:

getImportLayoutTable in interface ImportsLayoutSettings

getPackagesToUseImportOnDemand

public PackageEntryTable getPackagesToUseImportOnDemand()

Specified by:

getPackagesToUseImportOnDemand in interface ImportsLayoutSettings

isGenerateFinalLocals

public boolean isGenerateFinalLocals()

isGenerateFinalParameters

public boolean isGenerateFinalParameters()

importLegacySettings

protected void importLegacySettings(CodeStyleSettings rootSettings)

Description copied from class: CustomCodeStyleSettings

For compatibility with old code style settings stored in CodeStyleSettings.

Overrides:

importLegacySettings in class CustomCodeStyleSettings

clone

public java.lang.Object clone()

Overrides:

clone in class CustomCodeStyleSettings

readExternal

public void readExternal(Element parentElement)
                  throws InvalidDataException

Overrides:

readExternal in class CustomCodeStyleSettings

Throws:

InvalidDataException

writeExternal

public void writeExternal(Element parentElement,
                          CustomCodeStyleSettings parentSettings)
                   throws WriteExternalException

Overrides:

writeExternal in class CustomCodeStyleSettings

Throws:

WriteExternalException

getInstance

public static JavaCodeStyleSettings getInstance(PsiFile file)

getInstance

public static JavaCodeStyleSettings getInstance(Project project)

For production code use getInstance(PsiFile)

afterLoaded

protected void afterLoaded()

Description copied from class: CustomCodeStyleSettings

Fired when settings just loaded.

When the common version (the CodeStyleSettings.myVersion is not changed, this method is called just after loading. When the common version is changed, this method called after CustomCodeStyleSettings.importLegacySettings(com.intellij.psi.codeStyle.CodeStyleSettings).

Overrides:

afterLoaded in class CustomCodeStyleSettings

getKnownTagNames

public java.util.List<java.lang.String> getKnownTagNames()

Description copied from class: CustomCodeStyleSettings

in case settings save additional top-level tags, list the list of them to prevent serializer to treat such tag as unknown settings.

Overrides:

getKnownTagNames in class CustomCodeStyleSettings

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class CustomCodeStyleSettings