org.eclipse.m2e.jdt.internal

Class ClasspathEntryDescriptor

java.lang.Object

org.eclipse.m2e.jdt.internal.ClasspathEntryDescriptor

All Implemented Interfaces:

IClasspathEntryDescriptor

public class ClasspathEntryDescriptor
extends Object
implements IClasspathEntryDescriptor

ClasspathEntryDescriptor

Author:

igor

Constructor Summary

Constructors

Constructor and Description
ClasspathEntryDescriptor(org.eclipse.jdt.core.IClasspathEntry entry)
ClasspathEntryDescriptor(int entryKind, org.eclipse.core.runtime.IPath path)

Method Summary

Modifier and Type	Method and Description
void	addAccessRule(org.eclipse.jdt.core.IAccessRule rule)
void	addExclusionPattern(org.eclipse.core.runtime.IPath pattern)
void	addInclusionPattern(org.eclipse.core.runtime.IPath pattern)
boolean	combineAccessRules()
List<org.eclipse.jdt.core.IAccessRule>	getAccessRules()
String	getArtifactId() Short for getArtifactKey().getArtifactId(), with appropriate null check
ArtifactKey	getArtifactKey()
Map<String,String>	getClasspathAttributes()
int	getEntryKind()
org.eclipse.core.runtime.IPath[]	getExclusionPatterns()
String	getGroupId() Short for getArtifactKey().getGroupId(), with appropriate null check
org.eclipse.core.runtime.IPath[]	getInclusionPatterns()
String	getJavadocUrl()
org.eclipse.core.runtime.IPath	getOutputLocation()
org.eclipse.core.runtime.IPath	getPath()
String	getScope()
org.eclipse.core.runtime.IPath	getSourceAttachmentPath()
org.eclipse.core.runtime.IPath	getSourceAttachmentRootPath()
boolean	isExported()
boolean	isOptionalDependency()
boolean	isPomDerived() Returns true if this classpath entry was derived from pom.xml and false otherwise.
void	removeExclusionPattern(org.eclipse.core.runtime.IPath pattern)
void	removeInclusionPattern(org.eclipse.core.runtime.IPath pattern)
void	setArtifactKey(ArtifactKey artifactKey)
void	setClasspathAttribute(String name, String value)
void	setCombineAccessRules(boolean combineAccessRules)
void	setEntryKind(int entryKind)
void	setExclusionPatterns(org.eclipse.core.runtime.IPath[] exclusionPatterns)
void	setExported(boolean exported)
void	setInclusionPatterns(org.eclipse.core.runtime.IPath[] inclusionPatterns)
void	setJavadocUrl(String javaDocUrl)
void	setOptionalDependency(boolean optional)
void	setOutputLocation(org.eclipse.core.runtime.IPath outputLocation)
void	setPath(org.eclipse.core.runtime.IPath path)
void	setPomDerived(boolean derived) Marks classpath entry as derived from pom.xml (true) or not (false).
void	setScope(String scope)
void	setSourceAttachment(org.eclipse.core.runtime.IPath srcPath, org.eclipse.core.runtime.IPath srcRoot)
org.eclipse.jdt.core.IClasspathEntry	toClasspathEntry() Create IClasspathEntry with information collected in this descriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathEntryDescriptor

public ClasspathEntryDescriptor(int entryKind,
                                org.eclipse.core.runtime.IPath path)

ClasspathEntryDescriptor

public ClasspathEntryDescriptor(org.eclipse.jdt.core.IClasspathEntry entry)

Method Detail

toClasspathEntry

public org.eclipse.jdt.core.IClasspathEntry toClasspathEntry()

Description copied from interface: IClasspathEntryDescriptor

Create IClasspathEntry with information collected in this descriptor

Specified by:

toClasspathEntry in interface IClasspathEntryDescriptor

getScope

public String getScope()

Specified by:

getScope in interface IClasspathEntryDescriptor

isOptionalDependency

public boolean isOptionalDependency()

Specified by:

isOptionalDependency in interface IClasspathEntryDescriptor

Returns:

true if this entry corresponds to an optional maven dependency, false otherwise

setClasspathAttribute

public void setClasspathAttribute(String name,
                                  String value)

Specified by:

setClasspathAttribute in interface IClasspathEntryDescriptor

getClasspathAttributes

public Map<String,String> getClasspathAttributes()

Specified by:

getClasspathAttributes in interface IClasspathEntryDescriptor

getGroupId

public String getGroupId()

Description copied from interface: IClasspathEntryDescriptor

Short for getArtifactKey().getGroupId(), with appropriate null check

Specified by:

getGroupId in interface IClasspathEntryDescriptor

getArtifactId

public String getArtifactId()

Description copied from interface: IClasspathEntryDescriptor

Short for getArtifactKey().getArtifactId(), with appropriate null check

Specified by:

getArtifactId in interface IClasspathEntryDescriptor

getPath

public org.eclipse.core.runtime.IPath getPath()

Specified by:

getPath in interface IClasspathEntryDescriptor

setPath

public void setPath(org.eclipse.core.runtime.IPath path)

Specified by:

setPath in interface IClasspathEntryDescriptor

getEntryKind

public int getEntryKind()

Specified by:

getEntryKind in interface IClasspathEntryDescriptor

setEntryKind

public void setEntryKind(int entryKind)

Specified by:

setEntryKind in interface IClasspathEntryDescriptor

getArtifactKey

public ArtifactKey getArtifactKey()

Specified by:

getArtifactKey in interface IClasspathEntryDescriptor

setArtifactKey

public void setArtifactKey(ArtifactKey artifactKey)

Specified by:

setArtifactKey in interface IClasspathEntryDescriptor

setSourceAttachment

public void setSourceAttachment(org.eclipse.core.runtime.IPath srcPath,
                                org.eclipse.core.runtime.IPath srcRoot)

Specified by:

setSourceAttachment in interface IClasspathEntryDescriptor

setJavadocUrl

public void setJavadocUrl(String javaDocUrl)

Specified by:

setJavadocUrl in interface IClasspathEntryDescriptor

getSourceAttachmentPath

public org.eclipse.core.runtime.IPath getSourceAttachmentPath()

Specified by:

getSourceAttachmentPath in interface IClasspathEntryDescriptor

getSourceAttachmentRootPath

public org.eclipse.core.runtime.IPath getSourceAttachmentRootPath()

Specified by:

getSourceAttachmentRootPath in interface IClasspathEntryDescriptor

getJavadocUrl

public String getJavadocUrl()

Specified by:

getJavadocUrl in interface IClasspathEntryDescriptor

setScope

public void setScope(String scope)

Specified by:

setScope in interface IClasspathEntryDescriptor

setOptionalDependency

public void setOptionalDependency(boolean optional)

Specified by:

setOptionalDependency in interface IClasspathEntryDescriptor

addAccessRule

public void addAccessRule(org.eclipse.jdt.core.IAccessRule rule)

Specified by:

addAccessRule in interface IClasspathEntryDescriptor

getAccessRules

public List<org.eclipse.jdt.core.IAccessRule> getAccessRules()

Specified by:

getAccessRules in interface IClasspathEntryDescriptor

setOutputLocation

public void setOutputLocation(org.eclipse.core.runtime.IPath outputLocation)

Specified by:

setOutputLocation in interface IClasspathEntryDescriptor

getOutputLocation

public org.eclipse.core.runtime.IPath getOutputLocation()

Specified by:

getOutputLocation in interface IClasspathEntryDescriptor

setInclusionPatterns

public void setInclusionPatterns(org.eclipse.core.runtime.IPath[] inclusionPatterns)

Specified by:

setInclusionPatterns in interface IClasspathEntryDescriptor

addInclusionPattern

public void addInclusionPattern(org.eclipse.core.runtime.IPath pattern)

Specified by:

addInclusionPattern in interface IClasspathEntryDescriptor

removeInclusionPattern

public void removeInclusionPattern(org.eclipse.core.runtime.IPath pattern)

Specified by:

removeInclusionPattern in interface IClasspathEntryDescriptor

getInclusionPatterns

public org.eclipse.core.runtime.IPath[] getInclusionPatterns()

Specified by:

getInclusionPatterns in interface IClasspathEntryDescriptor

setExclusionPatterns

public void setExclusionPatterns(org.eclipse.core.runtime.IPath[] exclusionPatterns)

Specified by:

setExclusionPatterns in interface IClasspathEntryDescriptor

addExclusionPattern

public void addExclusionPattern(org.eclipse.core.runtime.IPath pattern)

Specified by:

addExclusionPattern in interface IClasspathEntryDescriptor

removeExclusionPattern

public void removeExclusionPattern(org.eclipse.core.runtime.IPath pattern)

Specified by:

removeExclusionPattern in interface IClasspathEntryDescriptor

getExclusionPatterns

public org.eclipse.core.runtime.IPath[] getExclusionPatterns()

Specified by:

getExclusionPatterns in interface IClasspathEntryDescriptor

setExported

public void setExported(boolean exported)

Specified by:

setExported in interface IClasspathEntryDescriptor

isExported

public boolean isExported()

Specified by:

isExported in interface IClasspathEntryDescriptor

setCombineAccessRules

public void setCombineAccessRules(boolean combineAccessRules)

Specified by:

setCombineAccessRules in interface IClasspathEntryDescriptor

combineAccessRules

public boolean combineAccessRules()

Specified by:

combineAccessRules in interface IClasspathEntryDescriptor

isPomDerived

public boolean isPomDerived()

Description copied from interface: IClasspathEntryDescriptor

Returns true if this classpath entry was derived from pom.xml and false otherwise.
Stale derived entries are automatically removed when workspace project configuration is synchronized with pom.xml.

Specified by:

isPomDerived in interface IClasspathEntryDescriptor

See Also:

IClasspathEntryDescriptor.setPomDerived(boolean)

setPomDerived

public void setPomDerived(boolean derived)

Description copied from interface: IClasspathEntryDescriptor

Marks classpath entry as derived from pom.xml (true) or not (false).

Not-derived (or custom) entries are preserved during project configuration update, while derived entries are automatically removed whenever their corresponding pom.xml configuration is changed or removed.

All new classpath entries are marked as derived by default, however value of this flag is preserved when entry descriptor is read from .classpath file. The intend is to make sure that custom classpath entries are not removed automatically. Clients of IClasspathDescriptor API who prefer to manage cleanup of stale class classpath entries explicitly may set derived flag to false.

Although not enforced, derived flag only applies to project 'raw' classpath entries. The flag is silently ignored for classpath container entries.

Specified by:

setPomDerived in interface IClasspathEntryDescriptor