Package org.apache.tools.ant
Class ProjectComponent
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable
 - Direct Known Subclasses:
- AbstractScriptComponent,- BaseIfAttribute,- Commandline.Argument,- Concat.TextElement,- ConditionBase,- DataType,- FailureRecorder,- FileTokenizer,- HasMethod,- Http,- IsFalse,- IsLastModified,- IsReachable,- IsReference,- IsSet,- IsTrue,- Javadoc.ExtensionInfo,- LineTokenizer,- Matches,- Message,- ParserSupports,- Provider,- ResourceExists,- Service,- Socket,- StringTokenizer,- Task,- TokenFilter.ChainableReaderFilter,- TokenFilter.ContainsString,- TokenFilter.DeleteCharacters,- TypeFound,- XMLFragment,- XSLTProcess.Factory.Attribute
 
 public abstract class ProjectComponent extends java.lang.Object implements java.lang.CloneableBase class for components of a project, including tasks and data types. Provides common facilities.
- 
- 
Field SummaryFields Modifier and Type Field Description protected java.lang.StringdescriptionDeprecated.since 1.6.x.protected LocationlocationDeprecated.since 1.6.x.protected ProjectprojectDeprecated.since 1.6.x.
 - 
Constructor SummaryConstructors Constructor Description ProjectComponent()Sole constructor.
 - 
Method SummaryModifier and Type Method Description java.lang.Objectclone()java.lang.StringgetDescription()Returns the description of the current action.LocationgetLocation()Returns the file/location where this task was defined.ProjectgetProject()Returns the project to which this component belongs.voidlog(java.lang.String msg)Logs a message with the default (INFO) priority.voidlog(java.lang.String msg, int msgLevel)Logs a message with the given priority.voidsetDescription(java.lang.String desc)Sets a description of the current action.voidsetLocation(Location location)Sets the file/location where this task was defined.voidsetProject(Project project)Sets the project object of this component.
 
- 
- 
- 
Field Detail- 
project@Deprecated protected Project project 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.
 - 
location@Deprecated protected Location location Deprecated.since 1.6.x. You should not be accessing this variable directly. Please use thegetLocation()method.Location within the build file of this task definition.
 - 
description@Deprecated protected java.lang.String description Deprecated.since 1.6.x. You should not be accessing this variable directly.Description of this component, if any.
 
- 
 - 
Method Detail- 
setProjectpublic void setProject(Project project) 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.
 
 - 
getProjectpublic Project getProject() Returns the project to which this component belongs.- Returns:
- the components's project.
 
 - 
getLocationpublic Location getLocation() Returns the file/location where this task was defined.- Returns:
- the file/location where this task was defined.
         Should not return null. Location.UNKNOWN_LOCATION is used for unknown locations.
- See Also:
- Location.UNKNOWN_LOCATION
 
 - 
setLocationpublic void setLocation(Location location) Sets the file/location where this task was defined.- 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:
- Location.UNKNOWN_LOCATION
 
 - 
setDescriptionpublic void setDescription(java.lang.String desc) 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 is available.
 
 - 
getDescriptionpublic java.lang.String getDescription() Returns the description of the current action.- Returns:
- the description of the current action, or nullif no description is available.
 
 - 
logpublic void log(java.lang.String msg) Logs a message with the default (INFO) priority.- Parameters:
- msg- The message to be logged. Should not be- null.
 
 - 
logpublic void log(java.lang.String msg, int msgLevel)Logs a message with the given priority.- Parameters:
- msg- The message to be logged. Should not be- null.
- msgLevel- the message priority at which this message is to be logged.
 
 - 
clonepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException- Overrides:
- clonein class- java.lang.Object
- Returns:
- a shallow copy of this projectcomponent.
- Throws:
- java.lang.CloneNotSupportedException- does not happen, but is declared to allow subclasses to do so.
- Since:
- Ant 1.7
 
 
- 
 
-