Java tutorial
/******************************************************************************* * Copyright (c) 2008-2010 Sonatype, Inc. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Sonatype, Inc. - initial API and implementation *******************************************************************************/ package org.eclipse.m2e.editor.composites; import java.util.Collection; import java.util.List; import org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider; import org.eclipse.jface.viewers.IColorProvider; import org.eclipse.jface.viewers.IDecoration; import org.eclipse.jface.viewers.LabelProvider; import org.eclipse.jface.viewers.StyledString; import org.eclipse.osgi.util.NLS; import org.eclipse.swt.SWT; import org.eclipse.swt.graphics.Color; import org.eclipse.swt.graphics.Image; import org.eclipse.swt.widgets.Display; import org.apache.maven.artifact.Artifact; import org.apache.maven.model.Dependency; import org.apache.maven.model.DependencyManagement; import org.apache.maven.model.InputLocation; import org.apache.maven.project.MavenProject; import org.eclipse.m2e.core.MavenPlugin; import org.eclipse.m2e.core.project.IMavenProjectFacade; import org.eclipse.m2e.core.project.IMavenProjectRegistry; import org.eclipse.m2e.core.ui.internal.MavenImages; import org.eclipse.m2e.editor.MavenEditorImages; import org.eclipse.m2e.editor.internal.Messages; import org.eclipse.m2e.editor.pom.MavenPomEditor; import org.eclipse.m2e.editor.pom.ValueProvider; /** * Label provider for Dependency, Exclusion and Extension elements * * @author Eugene Kuleshov */ public class DependencyLabelProvider extends LabelProvider implements IColorProvider, DelegatingStyledCellLabelProvider.IStyledLabelProvider { private MavenPomEditor pomEditor; private boolean showGroupId = false; private final boolean showManagedOverlay; private ValueProvider<List<org.apache.maven.model.Dependency>> valueProvider; public DependencyLabelProvider() { this(false); } public DependencyLabelProvider(boolean showManagedOverlay) { super(); this.showManagedOverlay = showManagedOverlay; } public void setPomEditor(MavenPomEditor pomEditor, ValueProvider<List<org.apache.maven.model.Dependency>> valueProvider) { assert pomEditor != null; this.pomEditor = pomEditor; this.valueProvider = valueProvider; } public void setShowGroupId(boolean showGroupId) { this.showGroupId = showGroupId; } // IColorProvider public Color getForeground(Object element) { //a workaround to handle display in ManagedDependenciesDialog //TODO shall have a switch of it's own.. the curse of blind code reuse if (showManagedOverlay && element instanceof org.apache.maven.model.Dependency) { //mkleint: let's just assume all maven Dependency instances are inherited return Display.getDefault().getSystemColor(SWT.COLOR_DARK_GRAY); } return null; } public Color getBackground(Object element) { return null; } private String[] findManaged(DependenciesComposite.Dependency dep) { if (pomEditor != null) { MavenProject mp = pomEditor.getMavenProject(); String version = null; String scope = null; if (mp != null) { String id = mp.getGroupId() + ":" + mp.getArtifactId() + ":" + mp.getVersion(); DependencyManagement dm = mp.getDependencyManagement(); if (dm != null) { for (org.apache.maven.model.Dependency d : dm.getDependencies()) { if (d.getGroupId().equals(dep.groupId) && d.getArtifactId().equals(dep.artifactId)) { //based on location, try finding a match in the live Model InputLocation location = d.getLocation("artifactId"); if (location != null) { if (id.equals(location.getSource().getModelId())) { version = d.getVersion(); scope = d.getScope(); break; } } return new String[] { d.getVersion(), d.getScope() }; } } } } List<org.apache.maven.model.Dependency> dm = valueProvider.getValue(); for (org.apache.maven.model.Dependency modelDep : dm) { String modelGroupId = modelDep.getGroupId(); String modelArtifactId = modelDep.getArtifactId(); String modelVersion = modelDep.getVersion(); String modelScope = modelDep.getScope(); if (modelGroupId != null && modelGroupId.equals(dep.groupId) && modelArtifactId != null && modelArtifactId.equals(dep.artifactId)) { if (version != null && (modelVersion == null || modelVersion.contains("${"))) { //prefer the resolved version to the model one if the model version as expressions.. return new String[] { version, modelScope == null ? scope : modelScope }; } return new String[] { modelVersion, modelScope == null ? scope : modelScope }; } } } return null; } public StyledString getStyledText(Object element) { if (element instanceof DependenciesComposite.Dependency) { StyledString ss = new StyledString(getText(element)); DependenciesComposite.Dependency dep = (DependenciesComposite.Dependency) element; String[] managed = findManaged(dep); if (managed != null && managed[0] != null) { String man = managed[0]; if (managed[1] != null && !Artifact.SCOPE_COMPILE.equals(managed[1])) { man = man + "," + managed[1]; } ss.append(NLS.bind(Messages.DependencyLabelProvider_0, man), StyledString.DECORATIONS_STYLER); } return ss; } return new StyledString(getText(element)); } // LabelProvider @Override public String getText(Object element) { if (element instanceof DependenciesComposite.Dependency) { DependenciesComposite.Dependency dependency = (DependenciesComposite.Dependency) element; return getText(dependency.groupId, dependency.artifactId, dependency.version, // dependency.classifier, dependency.type, dependency.scope); } else if (element instanceof org.apache.maven.model.Dependency) { org.apache.maven.model.Dependency dependency = (org.apache.maven.model.Dependency) element; return getText(dependency.getGroupId(), dependency.getArtifactId(), dependency.getVersion(), dependency.getClassifier(), dependency.getType(), dependency.getScope()); // } else if(element instanceof Exclusion) { // Exclusion exclusion = (Exclusion) element; // return getText(exclusion.getGroupId(), exclusion.getArtifactId(), null, null, null, null); // } else if(element instanceof Extension) { // Extension extension = (Extension) element; // return getText(extension.getGroupId(), extension.getArtifactId(), extension.getVersion(), null, null, null); } return super.getText(element); } @Override public Image getImage(Object element) { if (element instanceof DependenciesComposite.Dependency) { DependenciesComposite.Dependency dependency = (DependenciesComposite.Dependency) element; boolean isManaged = showManagedOverlay && findManaged(dependency) != null; return getImage(dependency.groupId, dependency.artifactId, dependency.version, isManaged); } else if (element instanceof org.apache.maven.model.Dependency) { if (!showManagedOverlay) { org.apache.maven.model.Dependency dependency = (Dependency) element; //a workaround to handle display in ManagedDependenciesDialog //TODO shall have a switch of it's own.. the curse of blind code reuse return getImage(dependency.getGroupId(), dependency.getArtifactId(), dependency.getVersion(), false); } //mkleint: all MavenDependency instances are inherited but only in *dependenciesComposite* return MavenEditorImages.IMG_INHERITED; // }else if(element instanceof Exclusion) { // Exclusion exclusion = (Exclusion) element; // return getImage(exclusion.getGroupId(), exclusion.getArtifactId(), null, false); // } else if(element instanceof Extension) { // Extension extension = (Extension) element; // return getImage(extension.getGroupId(), extension.getArtifactId(), extension.getVersion(), false); } return null; } private Image getImage(String groupId, String artifactId, String version, boolean isManaged) { // XXX need to resolve actual dependencies (i.e. inheritance, dependency management or properties) // XXX need to handle version ranges if ((version == null || version.indexOf("${") > -1) && pomEditor != null) { //$NON-NLS-1$ MavenProject mavenProject = pomEditor.getMavenProject(); if (mavenProject != null) { Artifact artifact = mavenProject.getArtifactMap().get(groupId + ":" + artifactId); //$NON-NLS-1$ if (artifact != null) { version = artifact.getVersion(); } if (version == null || version.indexOf("${") > -1) { //$NON-NLS-1$ Collection<Artifact> artifacts = mavenProject.getManagedVersionMap().values(); for (Artifact a : artifacts) { if (a.getGroupId().equals(groupId) && a.getArtifactId().equals(artifactId)) { version = a.getVersion(); break; } } } } } if (groupId != null && artifactId != null && version != null) { IMavenProjectRegistry projectManager = MavenPlugin.getMavenProjectRegistry(); IMavenProjectFacade projectFacade = projectManager.getMavenProject(groupId, artifactId, version); if (projectFacade != null) { return isManaged ? MavenImages.getOverlayImage(MavenImages.PATH_PROJECT, MavenImages.PATH_LOCK, IDecoration.BOTTOM_LEFT) : MavenEditorImages.IMG_PROJECT; } } return isManaged ? MavenImages.getOverlayImage(MavenImages.PATH_JAR, MavenImages.PATH_LOCK, IDecoration.BOTTOM_LEFT) : MavenEditorImages.IMG_JAR; } private String getText(String groupId, String artifactId, String version, String classifier, String type, String scope) { StringBuilder sb = new StringBuilder(); if (showGroupId) { sb.append(isEmpty(groupId) ? "?" : groupId).append(" : "); //$NON-NLS-1$ //$NON-NLS-2$ } sb.append(isEmpty(artifactId) ? "?" : artifactId); //$NON-NLS-1$ if (!isEmpty(version)) { sb.append(" : ").append(version); //$NON-NLS-1$ } if (!isEmpty(classifier)) { sb.append(" : ").append(classifier); //$NON-NLS-1$ } if (!isEmpty(type)) { sb.append(" : ").append(type); //$NON-NLS-1$ } if (!isEmpty(scope)) { sb.append(" [").append(scope).append(']'); //$NON-NLS-1$ } return sb.toString(); } private boolean isEmpty(String s) { return s == null || s.trim().length() == 0; } }