org.eclipse.m2e.editor.pom

Class MavenPomEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.ui.part.MultiPageEditorPart

org.eclipse.ui.forms.editor.FormEditor

org.eclipse.m2e.editor.pom.MavenPomEditor

Type Parameters:

page -

All Implemented Interfaces:

EventListener, org.eclipse.core.resources.IResourceChangeListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.jface.dialogs.IPageChangeProvider, IMavenProjectChangedListener, org.eclipse.search.ui.text.ISearchEditorAccess, org.eclipse.ui.ide.IGotoMarker, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IShowEditorInput, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class MavenPomEditor
extends org.eclipse.ui.forms.editor.FormEditor
implements org.eclipse.core.resources.IResourceChangeListener, org.eclipse.ui.IShowEditorInput, org.eclipse.ui.ide.IGotoMarker, org.eclipse.search.ui.text.ISearchEditorAccess, IMavenProjectChangedListener

Maven POM editor

Author:

Eugene Kuleshov, Anton Kraev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MavenPomEditor.MavenStructuredTextViewer
protected class	MavenPomEditor.StructuredSourceTextEditor

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDITOR_ID

Fields inherited from class org.eclipse.ui.forms.editor.FormEditor

pages

Fields inherited from class org.eclipse.ui.part.MultiPageEditorPart

PAGE_CONTAINER_SITE

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
MavenPomEditor()

Method Summary

Modifier and Type	Method and Description
protected void	addPages()
protected boolean	checkReadOnly() read/write check for read only pom files -- called when the file is opened and will validateEdit -- so files will be checked out of src control, etc Note: this is actually done separately from isReadOnly() because there are 2 notions of 'read only' for a POM.
protected org.eclipse.ui.IEditorSite	createSite(org.eclipse.ui.IEditorPart editor)
void	dispose()
void	doSave(org.eclipse.core.runtime.IProgressMonitor monitor) Saves structured editor XXX form model need to be synchronized
void	doSaveAs()
<T> T	getAdapter(Class<T> adapter)
org.eclipse.jface.text.source.IAnnotationModel	getAnnotationModel(org.eclipse.search.ui.text.Match match)
org.eclipse.jface.text.IDocument	getDocument() the pom document being edited..
org.eclipse.jface.text.IDocument	getDocument(org.eclipse.search.ui.text.Match match)
org.eclipse.wst.xml.core.internal.provisional.document.IDOMElement	getElement(org.eclipse.emf.ecore.EObject o)
List<MavenPomEditorPage>	getMavenPomEditorPages() returns only the pages that implement MavenPomEditorPage will not return the effective pom and xml editor page for example..
org.apache.maven.project.MavenProject	getMavenProject() this method is safer than readMavenProject for instances that shall return fast and don't mind not having the MavenProject instance around.
org.eclipse.wst.sse.core.internal.provisional.IStructuredModel	getModel()
List<MavenPomEditorPage>	getPages() Deprecated.
org.eclipse.core.resources.IFile	getPomFile()
org.eclipse.wst.sse.ui.StructuredTextEditor	getSourcePage()
void	gotoMarker(org.eclipse.core.resources.IMarker marker)
void	init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput editorInput)
boolean	isDirty()
boolean	isReadOnly()
boolean	isSaveAsAllowed()
void	mavenProjectChanged(MavenProjectChangedEvent[] events, org.eclipse.core.runtime.IProgressMonitor monitor) you may be asking why we have this method here..
protected void	pageChange(int newPageIndex)
org.eclipse.aether.graph.DependencyNode	readDependencyTree(boolean force, String classpath, org.eclipse.core.runtime.IProgressMonitor monitor)
org.apache.maven.project.MavenProject	readMavenProject(boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) either returns the cached MavenProject instance or reads it, please note that if you want your method to always return fast getMavenProject() is preferable please see mavenProjectChanged() for explanation why even force==true might not give you the latest uptodate MavenProject instance matching the current saved file in some circumstances.
void	reload()
void	resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event) Closes all project files on project close.
protected void	selectActivePage()
org.eclipse.ui.forms.editor.IFormPage	setActivePage(String pageId)
void	showDependencyHierarchy(ArtifactKey artifactKey)
void	showEditorInput(org.eclipse.ui.IEditorInput editorInput)
void	showInSourceEditor(org.eclipse.emf.ecore.EObject o)

Methods inherited from class org.eclipse.ui.forms.editor.FormEditor

addPage, addPage, addPage, addPage, addPage, addPage, close, commitPages, configurePage, createPageContainer, createPages, createToolkit, editorDirtyStateChanged, findPage, getActiveEditor, getActivePageInstance, getCurrentPage, getSelectedPage, getToolkit, removePage, selectReveal, setActivePage, setActivePage, updateActionBarContributor

Methods inherited from class org.eclipse.ui.part.MultiPageEditorPart

activateSite, addPageChangedListener, createPartControl, deactivateSite, findEditors, getActivePage, getContainer, getControl, getEditor, getPageCount, getPageImage, getPageSite, getPageText, handlePropertyChange, initializePageSwitching, removePageChangedListener, setActiveEditor, setControl, setFocus, setPageImage, setPageText

Methods inherited from class org.eclipse.ui.part.EditorPart

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener

Field Detail

EDITOR_ID

public static final String EDITOR_ID

See Also:

Constant Field Values

Constructor Detail

MavenPomEditor

public MavenPomEditor()

Method Detail

getDocument

public org.eclipse.jface.text.IDocument getDocument()

the pom document being edited..

Returns:

getModel

public org.eclipse.wst.sse.core.internal.provisional.IStructuredModel getModel()

resourceChanged

public void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)

Closes all project files on project close.

Specified by:

resourceChanged in interface org.eclipse.core.resources.IResourceChangeListener

reload

public void reload()

addPages

protected void addPages()

Specified by:

addPages in class org.eclipse.ui.forms.editor.FormEditor

selectActivePage

protected void selectActivePage()

pageChange

protected void pageChange(int newPageIndex)

Overrides:

pageChange in class org.eclipse.ui.forms.editor.FormEditor

createSite

protected org.eclipse.ui.IEditorSite createSite(org.eclipse.ui.IEditorPart editor)

Overrides:

createSite in class org.eclipse.ui.part.MultiPageEditorPart

isReadOnly

public boolean isReadOnly()

readDependencyTree

public org.eclipse.aether.graph.DependencyNode readDependencyTree(boolean force,
                                                                  String classpath,
                                                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                                                           throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject()

this method is safer than readMavenProject for instances that shall return fast and don't mind not having the MavenProject instance around.

Returns:

the cached MavenProject instance or null if not loaded.

readMavenProject

public org.apache.maven.project.MavenProject readMavenProject(boolean force,
                                                              org.eclipse.core.runtime.IProgressMonitor monitor)
                                                       throws org.eclipse.core.runtime.CoreException

either returns the cached MavenProject instance or reads it, please note that if you want your method to always return fast getMavenProject() is preferable please see mavenProjectChanged() for explanation why even force==true might not give you the latest uptodate MavenProject instance matching the current saved file in some circumstances.

Parameters:

force -

monitor -

Returns:

Throws:

org.eclipse.core.runtime.CoreException

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchPart

Overrides:

dispose in class org.eclipse.ui.forms.editor.FormEditor

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)

Saves structured editor XXX form model need to be synchronized

Specified by:

doSave in interface org.eclipse.ui.ISaveablePart

Specified by:

doSave in class org.eclipse.ui.part.EditorPart

doSaveAs

public void doSaveAs()

Specified by:

doSaveAs in interface org.eclipse.ui.ISaveablePart

Specified by:

doSaveAs in class org.eclipse.ui.part.EditorPart

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface org.eclipse.ui.ISaveablePart

Specified by:

isSaveAsAllowed in class org.eclipse.ui.part.EditorPart

init

public void init(org.eclipse.ui.IEditorSite site,
                 org.eclipse.ui.IEditorInput editorInput)
          throws org.eclipse.ui.PartInitException

Specified by:

init in interface org.eclipse.ui.IEditorPart

Overrides:

init in class org.eclipse.ui.forms.editor.FormEditor

Throws:

org.eclipse.ui.PartInitException

showInSourceEditor

public void showInSourceEditor(org.eclipse.emf.ecore.EObject o)

getElement

public org.eclipse.wst.xml.core.internal.provisional.document.IDOMElement getElement(org.eclipse.emf.ecore.EObject o)

showEditorInput

public void showEditorInput(org.eclipse.ui.IEditorInput editorInput)

Specified by:

showEditorInput in interface org.eclipse.ui.IShowEditorInput

gotoMarker

public void gotoMarker(org.eclipse.core.resources.IMarker marker)

Specified by:

gotoMarker in interface org.eclipse.ui.ide.IGotoMarker

getDocument

public org.eclipse.jface.text.IDocument getDocument(org.eclipse.search.ui.text.Match match)

Specified by:

getDocument in interface org.eclipse.search.ui.text.ISearchEditorAccess

getAnnotationModel

public org.eclipse.jface.text.source.IAnnotationModel getAnnotationModel(org.eclipse.search.ui.text.Match match)

Specified by:

getAnnotationModel in interface org.eclipse.search.ui.text.ISearchEditorAccess

isDirty

public boolean isDirty()

Specified by:

isDirty in interface org.eclipse.ui.ISaveablePart

Overrides:

isDirty in class org.eclipse.ui.forms.editor.FormEditor

getMavenPomEditorPages

public List<MavenPomEditorPage> getMavenPomEditorPages()

returns only the pages that implement MavenPomEditorPage will not return the effective pom and xml editor page for example..

Returns:

getPages

@Deprecated
public List<MavenPomEditorPage> getPages()

Deprecated.

use the getMavenPomEditorPages() method instead

Returns:

showDependencyHierarchy

public void showDependencyHierarchy(ArtifactKey artifactKey)

checkReadOnly

protected boolean checkReadOnly()

read/write check for read only pom files -- called when the file is opened and will validateEdit -- so files will be checked out of src control, etc Note: this is actually done separately from isReadOnly() because there are 2 notions of 'read only' for a POM. The first is for a file downloaded from a repo, like maven central. That one is never editable. The second is for a local file that is read only because its been marked that way by an SCM, etc. This method will do a one-time check/validateEdit for the life of the POM editor.

getSourcePage

public org.eclipse.wst.sse.ui.StructuredTextEditor getSourcePage()

setActivePage

public org.eclipse.ui.forms.editor.IFormPage setActivePage(String pageId)

Overrides:

setActivePage in class org.eclipse.ui.forms.editor.FormEditor

getAdapter

public <T> T getAdapter(Class<T> adapter)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

Overrides:

getAdapter in class org.eclipse.ui.part.MultiPageEditorPart

getPomFile

public org.eclipse.core.resources.IFile getPomFile()

mavenProjectChanged

public void mavenProjectChanged(MavenProjectChangedEvent[] events,
                                org.eclipse.core.runtime.IProgressMonitor monitor)

you may be asking why we have this method here.. sit back, relax and let me tell you the epic story of it.. 1. we attempt to keep an instance of MavenProject instance around - to make queries from xml editor and elsewhere easy and *fast*. 2. in init() we read it and store 3. however how do we update the value when stuff changes? 4. only IFileEditorInputs are really update-able, everything else is a read-only editor. 5. so how do we listen on the resource being changed and update the value accordingly? it appears that Selectionutil.getMavenProject(EditorInput) relies on MavenProjectManager.create() which appears to have rather tricky behaviour. It either gives you the cached instance or if not around creates one on the fly. 5a. The fly one is however not added to the cache. As a consequence the fly ones are always recreated each time you ask. 5b. The cached ones react quite in opposite way, no matter when you ask (even if you know the file has changed) you always get the cached value until the registry gets updated. 6. so to keep our MavenProject instance uptodate for both 5a and 5b cases, we need to: 6a. listen on workspace resources and try loading the MavenProject. for 5a it will load the new instance but for 5b it will keep returning the old value. 6b. so we also listen on MavenProjectChangedEvents and for 5b cases get the correct, fresh new MavenProject instance here. 7. please note that 6a comes before 6b and is done for both 5a and 5b as it's hard to tell those IMavenprojectfacade instances apart.. Your storyteller for tonite was mkleint

Specified by:

mavenProjectChanged in interface IMavenProjectChangedListener