org.eclipse.xtext.builder
Class DerivedResourceMarkers

java.lang.Object
  extended by org.eclipse.xtext.builder.DerivedResourceMarkers
All Implemented Interfaces:
IDerivedResourceMarkers

public class DerivedResourceMarkers
extends java.lang.Object
implements IDerivedResourceMarkers

Since:
2.1
Author:
Sven Efftinge - Initial contribution and API

Nested Class Summary
static class DerivedResourceMarkers.GeneratorIdProvider
           
 
Field Summary
static java.lang.String ATTR_GENERATOR
           
static java.lang.String ATTR_SOURCE
           
static java.lang.String MARKER_ID
           
 
Constructor Summary
DerivedResourceMarkers()
           
 
Method Summary
 org.eclipse.core.resources.IMarker findDerivedResourceMarker(org.eclipse.core.resources.IFile file, java.lang.String source)
          finds a single derived resource marker for the given file, corresponding to the given source.
 org.eclipse.core.resources.IMarker findDerivedResourceMarker(org.eclipse.core.resources.IFile file, java.lang.String generator, java.lang.String source)
           
 org.eclipse.core.resources.IMarker[] findDerivedResourceMarkers(org.eclipse.core.resources.IFile file)
          Deprecated. 
 org.eclipse.core.resources.IMarker[] findDerivedResourceMarkers(org.eclipse.core.resources.IResource file)
          Find all derived resource marker for the given resource and its children (if existent).
 java.lang.Iterable<org.eclipse.core.resources.IMarker> findDerivedResourceMarkers(org.eclipse.core.resources.IResource file, java.lang.String generatorId)
          Find all derived resource marker for the given resource and its children (if existent), which were installed for the given generatorId.
 java.util.List<org.eclipse.core.resources.IFile> findDerivedResources(org.eclipse.core.resources.IContainer container, java.lang.String source)
           
 java.util.List<org.eclipse.core.resources.IFile> findDerivedResources(org.eclipse.core.resources.IContainer container, java.lang.String generator, java.lang.String source)
           
 java.util.List<org.eclipse.core.resources.IFile> findDerivedResources(java.util.List<org.eclipse.core.resources.IMarker> generatorMarkers, java.lang.String source)
           
 java.util.List<org.eclipse.core.resources.IMarker> findGeneratorMarkers(org.eclipse.core.resources.IContainer container)
           
 java.util.List<org.eclipse.core.resources.IMarker> findGeneratorMarkers(org.eclipse.core.resources.IContainer container, java.lang.String generator)
           
 java.lang.String getSource(org.eclipse.core.resources.IMarker marker)
           
 boolean installMarker(org.eclipse.core.resources.IFile file, java.lang.String source)
           
 boolean installMarker(org.eclipse.core.resources.IFile file, java.lang.String generator, java.lang.String source)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MARKER_ID

public static final java.lang.String MARKER_ID
See Also:
Constant Field Values

ATTR_SOURCE

public static final java.lang.String ATTR_SOURCE
See Also:
Constant Field Values

ATTR_GENERATOR

public static final java.lang.String ATTR_GENERATOR
See Also:
Constant Field Values
Constructor Detail

DerivedResourceMarkers

public DerivedResourceMarkers()
Method Detail

findGeneratorMarkers

public java.util.List<org.eclipse.core.resources.IMarker> findGeneratorMarkers(org.eclipse.core.resources.IContainer container)
                                                                        throws org.eclipse.core.runtime.CoreException
Throws:
org.eclipse.core.runtime.CoreException
Since:
2.3

findGeneratorMarkers

public java.util.List<org.eclipse.core.resources.IMarker> findGeneratorMarkers(org.eclipse.core.resources.IContainer container,
                                                                               java.lang.String generator)
                                                                        throws org.eclipse.core.runtime.CoreException
Throws:
org.eclipse.core.runtime.CoreException
Since:
2.3

findDerivedResources

public java.util.List<org.eclipse.core.resources.IFile> findDerivedResources(java.util.List<org.eclipse.core.resources.IMarker> generatorMarkers,
                                                                             java.lang.String source)
                                                                      throws org.eclipse.core.runtime.CoreException
Throws:
org.eclipse.core.runtime.CoreException
Since:
2.3

findDerivedResources

public java.util.List<org.eclipse.core.resources.IFile> findDerivedResources(org.eclipse.core.resources.IContainer container,
                                                                             java.lang.String source)
                                                                      throws org.eclipse.core.runtime.CoreException
Specified by:
findDerivedResources in interface IDerivedResourceMarkers
Throws:
org.eclipse.core.runtime.CoreException

findDerivedResources

public java.util.List<org.eclipse.core.resources.IFile> findDerivedResources(org.eclipse.core.resources.IContainer container,
                                                                             java.lang.String generator,
                                                                             java.lang.String source)
                                                                      throws org.eclipse.core.runtime.CoreException
Throws:
org.eclipse.core.runtime.CoreException

findDerivedResourceMarkers

@Deprecated
public org.eclipse.core.resources.IMarker[] findDerivedResourceMarkers(org.eclipse.core.resources.IFile file)
                                                                throws org.eclipse.core.runtime.CoreException
Deprecated. 

Throws:
org.eclipse.core.runtime.CoreException

findDerivedResourceMarkers

public org.eclipse.core.resources.IMarker[] findDerivedResourceMarkers(org.eclipse.core.resources.IResource file)
                                                                throws org.eclipse.core.runtime.CoreException
Description copied from interface: IDerivedResourceMarkers
Find all derived resource marker for the given resource and its children (if existent).

Specified by:
findDerivedResourceMarkers in interface IDerivedResourceMarkers
Returns:
the generator markers or an empty array if none.
Throws:
org.eclipse.core.runtime.CoreException
Since:
2.3

findDerivedResourceMarkers

public java.lang.Iterable<org.eclipse.core.resources.IMarker> findDerivedResourceMarkers(org.eclipse.core.resources.IResource file,
                                                                                         java.lang.String generatorId)
                                                                                  throws org.eclipse.core.runtime.CoreException
Description copied from interface: IDerivedResourceMarkers
Find all derived resource marker for the given resource and its children (if existent), which were installed for the given generatorId.

Specified by:
findDerivedResourceMarkers in interface IDerivedResourceMarkers
Returns:
the generator markers or an empty Iterable if none.
Throws:
org.eclipse.core.runtime.CoreException
Since:
2.3

findDerivedResourceMarker

public org.eclipse.core.resources.IMarker findDerivedResourceMarker(org.eclipse.core.resources.IFile file,
                                                                    java.lang.String source)
                                                             throws org.eclipse.core.runtime.CoreException
Description copied from interface: IDerivedResourceMarkers
finds a single derived resource marker for the given file, corresponding to the given source.

Specified by:
findDerivedResourceMarker in interface IDerivedResourceMarkers
Returns:
the first found marker in the given file with the given source attribute or null if no such marker could be found.
Throws:
org.eclipse.core.runtime.CoreException

findDerivedResourceMarker

public org.eclipse.core.resources.IMarker findDerivedResourceMarker(org.eclipse.core.resources.IFile file,
                                                                    java.lang.String generator,
                                                                    java.lang.String source)
                                                             throws org.eclipse.core.runtime.CoreException
Throws:
org.eclipse.core.runtime.CoreException

getSource

public java.lang.String getSource(org.eclipse.core.resources.IMarker marker)
Specified by:
getSource in interface IDerivedResourceMarkers
Returns:
the 'source' attribute of the given marker

installMarker

public boolean installMarker(org.eclipse.core.resources.IFile file,
                             java.lang.String source)
                      throws org.eclipse.core.runtime.CoreException
Specified by:
installMarker in interface IDerivedResourceMarkers
Throws:
org.eclipse.core.runtime.CoreException

installMarker

public boolean installMarker(org.eclipse.core.resources.IFile file,
                             java.lang.String generator,
                             java.lang.String source)
                      throws org.eclipse.core.runtime.CoreException
Throws:
org.eclipse.core.runtime.CoreException