org.apache.tools.ant
public abstract class ProjectComponent extends Object implements Cloneable
Field Summary | |
---|---|
protected String | description
Description of this component, if any. |
protected Location | location
Location within the build file of this task definition. |
protected Project | project
Project object of this component. |
Constructor Summary | |
---|---|
ProjectComponent() Sole constructor. |
Method Summary | |
---|---|
Object | clone() |
String | getDescription()
Returns the description of the current action.
|
Location | getLocation()
Returns the file/location where this task was defined.
|
Project | getProject()
Returns the project to which this component belongs.
|
void | log(String msg)
Logs a message with the default (INFO) priority.
|
void | log(String msg, int msgLevel)
Logs a message with the given priority.
|
void | setDescription(String desc)
Sets a description of the current action. |
void | setLocation(Location location)
Sets the file/location where this task was defined.
|
void | setProject(Project project)
Sets the project object of this component. |
Deprecated: since 1.6.x. You should not be accessing this variable directly.
Description of this component, if any.Deprecated: since 1.6.x. You should not be accessing this variable directly. Please use the getLocation method.
Location within the build file of this task definition.Deprecated: since 1.6.x. You should not be directly accessing this variable directly. You should access project object via the getProject() or setProject() accessor/mutators.
Project object of this component.Returns: a shallow copy of this projectcomponent.
Throws: CloneNotSupportedException does not happen, but is declared to allow subclasses to do so.
Since: Ant 1.7
Returns: the description of the current action, or null
if
no description is available.
Returns: the file/location where this task was defined.
Should not return null
. Location.UNKNOWN_LOCATION
is used for unknown locations.
See Also: UNKNOWN_LOCATION
Returns: the components's project.
Parameters: msg The message to be logged. Should not be null
.
Parameters: msg The message to be logged. Should not be null
. msgLevel the message priority at which this message is
to be logged.
Parameters: desc Description of the current action.
May be null
, indicating that no description is
available.
Parameters: location The file/location where this task was defined.
Should not be null
--use
Location.UNKNOWN_LOCATION if the location isn't known.
See Also: UNKNOWN_LOCATION
Parameters: project Project in whose scope this component belongs.
Must not be null
.