Package com.intellij.javadoc

Class JavadocGenerationManager

java.lang.Object

com.intellij.javadoc.JavadocGenerationManager

All Implemented Interfaces:

PersistentStateComponent<JavadocConfiguration>

public final class JavadocGenerationManager
extends java.lang.Object
implements PersistentStateComponent<JavadocConfiguration>

Method Summary

Modifier and Type	Method and Description
void	generateJavadoc(AnalysisScope scope)
JavadocConfiguration	getConfiguration()
static JavadocGenerationManager	getInstance(Project project)
JavadocConfiguration	getState()
void	loadState(JavadocConfiguration state) This method is called when new component state is loaded.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Method Detail

getInstance

public static JavadocGenerationManager getInstance(Project project)

getState

public JavadocConfiguration getState()

Specified by:

getState in interface PersistentStateComponent<JavadocConfiguration>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(JavadocConfiguration state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<JavadocConfiguration>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getConfiguration

public JavadocConfiguration getConfiguration()

generateJavadoc

public void generateJavadoc(AnalysisScope scope)