Package org.apache.maven.model

Class Resource

java.lang.Object

org.apache.maven.model.PatternSet

org.apache.maven.model.FileSet

org.apache.maven.model.Resource

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

public class Resource
extends FileSet
implements Serializable, Cloneable

This element describes all of the classpath resources associated with a project or unit tests.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Resource()

Method Summary

Modifier and Type	Method	Description
Resource	clone()	Method clone.
String	getFiltering()	Get whether resources are filtered to replace tokens with parameterised values or not.
String	getMergeId()	Get fOR INTERNAL USE ONLY.
String	getTargetPath()	Get describe the resource target path.
void	initMergeId()
boolean	isFiltering()
void	setFiltering(boolean filtering)
void	setFiltering(String filtering)	Set whether resources are filtered to replace tokens with parameterised values or not.
void	setMergeId(String mergeId)	Set fOR INTERNAL USE ONLY.
void	setTargetPath(String targetPath)	Set describe the resource target path.
String	toString()

Methods inherited from class org.apache.maven.model.FileSet

getDirectory, setDirectory

Methods inherited from class org.apache.maven.model.PatternSet

addExclude, addInclude, getExcludes, getIncludes, getLocation, removeExclude, removeInclude, setExcludes, setIncludes, setLocation, setOtherLocation

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Resource

public Resource()

Method Detail

clone

public Resource clone()

Method clone.

Overrides:

clone in class FileSet

Returns:

Resource

getFiltering

public String getFiltering()

Get whether resources are filtered to replace tokens with parameterised values or not. The values are taken from the properties element and from the properties in the files listed in the filters element. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.

Returns:

String

getMergeId

public String getMergeId()

Get fOR INTERNAL USE ONLY. This is a unique identifier assigned to each resource to allow Maven to merge changes to this resource that take place during the execution of a plugin. This field must be managed by the generated parser and formatter classes in order to allow it to survive model interpolation.

Returns:

String

getTargetPath

public String getTargetPath()

Get describe the resource target path. The path is relative to the target/classes directory (i.e. ${project.build.outputDirectory}). For example, if you want that resource to appear in a specific package (org.apache.maven.messages), you must specify this element with this value: org/apache/maven/messages. This is not required if you simply put the resources in that directory structure at the source, however.

Returns:

String

setFiltering

public void setFiltering(String filtering)

Set whether resources are filtered to replace tokens with parameterised values or not. The values are taken from the properties element and from the properties in the files listed in the filters element. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.

Parameters:

filtering - a filtering object.

setMergeId

public void setMergeId(String mergeId)

Set fOR INTERNAL USE ONLY. This is a unique identifier assigned to each resource to allow Maven to merge changes to this resource that take place during the execution of a plugin. This field must be managed by the generated parser and formatter classes in order to allow it to survive model interpolation.

Parameters:

mergeId - a mergeId object.

setTargetPath

public void setTargetPath(String targetPath)

Set describe the resource target path. The path is relative to the target/classes directory (i.e. ${project.build.outputDirectory}). For example, if you want that resource to appear in a specific package (org.apache.maven.messages), you must specify this element with this value: org/apache/maven/messages. This is not required if you simply put the resources in that directory structure at the source, however.

Parameters:

targetPath - a targetPath object.

initMergeId

public void initMergeId()

isFiltering

public boolean isFiltering()

setFiltering

public void setFiltering(boolean filtering)

toString

public String toString()

Overrides:

toString in class FileSet

See Also:

Object.toString()