| java.lang.Object org.apache.tools.ant.ProjectComponent
All known Subclasses: org.apache.tools.ant.taskdefs.condition.Matches, org.apache.tools.ant.util.FileTokenizer, org.apache.tools.ant.taskdefs.condition.ParserSupports, org.apache.tools.ant.types.spi.Service, org.apache.tools.ant.taskdefs.condition.IsSet, org.apache.tools.ant.util.XMLFragment, org.apache.tools.ant.taskdefs.condition.ConditionBase, org.apache.tools.ant.taskdefs.condition.IsTrue, org.apache.tools.ant.types.spi.Provider, org.apache.tools.ant.taskdefs.condition.TypeFound, org.apache.tools.ant.taskdefs.condition.IsReference, org.apache.tools.ant.taskdefs.condition.IsFalse, org.example.types.TypedefTestType, org.apache.tools.ant.util.LineTokenizer, org.apache.tools.ant.taskdefs.condition.HasMethod, org.apache.tools.ant.taskdefs.condition.Socket, org.apache.tools.ant.types.optional.AbstractScriptComponent, org.apache.tools.ant.taskdefs.email.Message, org.apache.tools.ant.types.DataType, org.apache.tools.ant.taskdefs.condition.Http, org.apache.tools.ant.Task, org.apache.tools.ant.taskdefs.condition.IsReachable, org.apache.tools.ant.util.StringTokenizer,
ProjectComponent | abstract public class ProjectComponent implements Cloneable(Code) | | Base class for components of a project, including tasks and data types.
Provides common facilities.
|
Method Summary | |
public Object | clone() | public String | getDescription() Returns the description of the current action. | public Location | getLocation() Returns the file/location where this task was defined.
the file/location where this task was defined.Should not return null . | public Project | getProject() Returns the project to which this component belongs. | public void | log(String msg) Logs a message with the default (INFO) priority.
Parameters: msg - The message to be logged. | public void | log(String msg, int msgLevel) Logs a message with the given priority.
Parameters: msg - The message to be logged. | public void | setDescription(String desc) Sets a description of the current action. | public void | setLocation(Location location) Sets the file/location where this task was defined. | public void | setProject(Project project) Sets the project object of this component. |
description | protected String description(Code) | | Description of this component, if any.
|
project | protected Project project(Code) | | Project object of this component.
|
ProjectComponent | public ProjectComponent()(Code) | | Sole constructor.
|
getDescription | public String getDescription()(Code) | | Returns the description of the current action.
the description of the current action, or null ifno description is available. |
getLocation | public Location getLocation()(Code) | | Returns the file/location where this task was defined.
the file/location where this task was defined.Should not return null . Location.UNKNOWN_LOCATIONis used for unknown locations. See Also: Location.UNKNOWN_LOCATION |
getProject | public Project getProject()(Code) | | Returns the project to which this component belongs.
the components's project. |
log | public void log(String msg)(Code) | | Logs a message with the default (INFO) priority.
Parameters: msg - The message to be logged. Should not be null . |
log | public void log(String msg, int msgLevel)(Code) | | Logs a message with the given priority.
Parameters: msg - The message to be logged. Should not be null . Parameters: msgLevel - the message priority at which this message isto be logged. |
setDescription | public void setDescription(String desc)(Code) | | Sets a description of the current action. This may be used for logging
purposes.
Parameters: desc - Description of the current action.May be null , indicating that no description isavailable. |
setLocation | public void setLocation(Location location)(Code) | | Sets the file/location where this task was defined.
Parameters: location - The file/location where this task was defined.Should not be null --useLocation.UNKNOWN_LOCATION if the location isn't known. See Also: Location.UNKNOWN_LOCATION |
setProject | public void setProject(Project project)(Code) | | Sets the project object of this component. This method is used by
Project when a component is added to it so that the component has
access to the functions of the project. It should not be used
for any other purpose.
Parameters: project - Project in whose scope this component belongs.Must not be null . |
|
|