Package org.apache.tools.ant
Class ProjectComponent
java.lang.Object
org.apache.tools.ant.ProjectComponent
- All Implemented Interfaces:
- 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,- Permissions,- Provider,- ResourceExists,- Service,- Socket,- StringTokenizer,- Task,- TokenFilter.ChainableReaderFilter,- TokenFilter.ContainsString,- TokenFilter.DeleteCharacters,- TypeFound,- XMLFragment,- XSLTProcess.Factory.Attribute
Base class for components of a project, including tasks and data types.
 Provides common facilities.
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionclone()Returns the description of the current action.Returns the file/location where this task was defined.Returns the project to which this component belongs.voidLogs a message with the default (INFO) priority.voidLogs a message with the given priority.voidsetDescription(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 Details- 
projectDeprecated.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.
- 
locationDeprecated.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.
- 
descriptionDeprecated.since 1.6.x. You should not be accessing this variable directly.Description of this component, if any.
 
- 
- 
Constructor Details- 
ProjectComponentpublic ProjectComponent()Sole constructor.
 
- 
- 
Method Details- 
setProjectSets 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.
 
- 
getProjectReturns the project to which this component belongs.- Returns:
- the components's project.
 
- 
getLocationReturns 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:
 
- 
setLocationSets 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:
 
- 
setDescriptionSets 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.
 
- 
getDescriptionReturns the description of the current action.- Returns:
- the description of the current action, or nullif no description is available.
 
- 
logLogs a message with the default (INFO) priority.- Parameters:
- msg- The message to be logged. Should not be- null.
 
- 
logLogs 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.
 
- 
clone- Overrides:
- clonein class- Object
- 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
 
 
-