net.sf.ant4eclipse.ant.task.project
Class GetReferencedProjectsTask

java.lang.Object
  extended by Task
      extended by net.sf.ant4eclipse.ant.task.project.AbstractProjectBasedTask
          extended by net.sf.ant4eclipse.ant.task.project.GetReferencedProjectsTask

public class GetReferencedProjectsTask
extends AbstractProjectBasedTask

Returns all referenced projects of a specified project


Nested Class Summary
static class GetReferencedProjectsTask.NonJavaProjectHandling
          
 
Field Summary
static java.lang.String DEFAULT_SEPARATOR
          the default seperator
static java.lang.String SOURCE_CLASSPATH
          read projects from classpath (default)
static java.lang.String SOURCE_PROJECT
          read projects from .project file
 
Constructor Summary
GetReferencedProjectsTask()
           
 
Method Summary
 void execute()
          
 java.lang.String getProperty()
           Returns the name of an ant property that will hold the list of referenced projects.
 java.lang.String getSeparator()
           Returns an (optional) separator that is used to separate the project names.
 java.lang.String getSource()
           Return where to read the referenced projects from.
 boolean isExportedOnly()
           
 boolean isPropertySet()
           
 boolean isReadFromClasspath()
           
 boolean isReadFromProject()
           
 boolean isRecursive()
           Returns if required projects should be resolve recursive.
 void requirePropertySet()
           
protected  void requireSourceSet()
           
 void setExportedOnly(boolean exportedOnly)
           
 void setProperty(java.lang.String property)
           Sets the name of an ant property that will hold the list of referenced projects.
 void setRecursive(boolean recursive)
           Specifies if required projects should be resolve recursive.
 void setSeparator(java.lang.String separator)
           Sets an (optional) separator that is used to separate the project names.
 void setSource(java.lang.String source)
           Sets where to read the referenced projects from.
 
Methods inherited from class net.sf.ant4eclipse.ant.task.project.AbstractProjectBasedTask
ensureJavaProject, getEclipseProject, getWorkspace, hasText, isProjectNameSet, isProjectSet, isWorkspaceSet, requireWorkspaceAndProjectNameOrProjectSet, requireWorkspaceSet, setInitialiseWorkspace, setProject, setProjectName, setWorkspace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR
the default seperator

See Also:
Constant Field Values

SOURCE_CLASSPATH

public static final java.lang.String SOURCE_CLASSPATH
read projects from classpath (default)

See Also:
Constant Field Values

SOURCE_PROJECT

public static final java.lang.String SOURCE_PROJECT
read projects from .project file

See Also:
Constant Field Values
Constructor Detail

GetReferencedProjectsTask

public GetReferencedProjectsTask()
Method Detail

getProperty

public java.lang.String getProperty()

Returns the name of an ant property that will hold the list of referenced projects.

Returns:
the name of an ant property that will hold the list of referenced projects.

setProperty

public void setProperty(java.lang.String property)

Sets the name of an ant property that will hold the list of referenced projects.

Parameters:
property - the name of an ant property that will hold the list of referenced projects.

getSeparator

public java.lang.String getSeparator()

Returns an (optional) separator that is used to separate the project names.

Returns:
an (optional) separator that is used to separate the project names.

setSeparator

public void setSeparator(java.lang.String separator)

Sets an (optional) separator that is used to separate the project names.

Parameters:
separator - an (optional) separator that is used to separate the project names.

getSource

public java.lang.String getSource()

Return where to read the referenced projects from. Allowed values are 'classpath' or 'project'.

Returns:
where to read the referenced projects from.

setSource

public void setSource(java.lang.String source)

Sets where to read the referenced projects from. Allowed values are 'classpath' or 'project'.

Parameters:
source - where to read the referenced projects from.

isRecursive

public boolean isRecursive()

Returns if required projects should be resolve recursive.

Returns:

setRecursive

public void setRecursive(boolean recursive)

Specifies if required projects should be resolve recursive. This attibute is optional and has to be specified only when source=project. Defaults to true.

Parameters:
recursive - true if required projects should be resolve recursive.

isExportedOnly

public boolean isExportedOnly()

setExportedOnly

public void setExportedOnly(boolean exportedOnly)

isPropertySet

public boolean isPropertySet()

requirePropertySet

public void requirePropertySet()

requireSourceSet

protected void requireSourceSet()

isReadFromProject

public boolean isReadFromProject()

isReadFromClasspath

public boolean isReadFromClasspath()

execute

public void execute()
             throws BuildException

Throws:
BuildException