|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.jomc.ant.JomcTask
org.jomc.ant.MergeModletsTask
public final class MergeModletsTask
Task for merging modlet resources.
Field Summary |
---|
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
MergeModletsTask()
Creates a new MergeModletsTask instance. |
Method Summary | |
---|---|
MergeModletsTask |
clone()
Creates and returns a copy of this object. |
NameType |
createModletExclude()
Creates a new modletExclude element instance. |
NameType |
createModletInclude()
Creates a new modletInclude element instance. |
TransformerResourceType |
createModletObjectStylesheetResource()
Creates a new modletObjectStylesheetResource element instance. |
ModletResourceType |
createModletResource()
Creates a new modletResource element instance. |
void |
executeTask()
Merges modlet resources. |
String |
getModletEncoding()
Gets the encoding of the modlet resource. |
Set<NameType> |
getModletExcludes()
Gets a set of modlet names to exclude. |
File |
getModletFile()
Gets the file to write the merged modlet to. |
Set<NameType> |
getModletIncludes()
Gets a set of modlet names to include. |
String |
getModletName()
Gets the name of the merged modlet. |
List<TransformerResourceType> |
getModletObjectStylesheetResources()
Gets the XSLT documents to use for transforming modlet objects. |
Set<ModletResourceType> |
getModletResources()
Gets a set of resource names to merge. |
String |
getModletVendor()
Gets the vendor of the merged modlet. |
String |
getModletVersion()
Gets the version of the merged modlet. |
boolean |
isModletExcluded(Modlet modlet)
Tests exclusion of a given modlet based on property modletExcludes . |
boolean |
isModletIncluded(Modlet modlet)
Tests inclusion of a given modlet based on property modletIncludes . |
void |
preExecuteTask()
Called by the execute method prior to the executeTask method. |
void |
setModletEncoding(String value)
Sets the encoding of the modlet resource. |
void |
setModletFile(File value)
Sets the file to write the merged modlet to. |
void |
setModletName(String value)
Sets the name of the merged modlet. |
void |
setModletVendor(String value)
Sets the vendor of the merged modlet. |
void |
setModletVersion(String value)
Sets the version of the merged modlet. |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MergeModletsTask()
MergeModletsTask
instance.
Method Detail |
---|
public File getModletFile()
null
.setModletFile(java.io.File)
public void setModletFile(File value)
value
- The new file to write the merged modlet to or null
.getModletFile()
public String getModletEncoding()
setModletEncoding(java.lang.String)
public void setModletEncoding(String value)
value
- The new encoding of the modlet resource or null
.getModletEncoding()
public String getModletName()
null
.setModletName(java.lang.String)
public void setModletName(String value)
value
- The new name of the merged modlet or null
.getModletName()
public String getModletVersion()
null
.setModletVersion(java.lang.String)
public void setModletVersion(String value)
value
- The new version of the merged modlet or null
.getModletVersion()
public String getModletVendor()
null
.setModletVendor(java.lang.String)
public void setModletVendor(String value)
value
- The new vendor of the merged modlet or null
.getModletVendor()
public Set<ModletResourceType> getModletResources()
This accessor method returns a reference to the live set, not a snapshot. Therefore any modification you make
to the returned set will be present inside the object. This is why there is no set
method for the
modlet resources property.
createModletResource()
public ModletResourceType createModletResource()
modletResource
element instance.
modletResource
element instance.getModletResources()
public Set<NameType> getModletIncludes()
This accessor method returns a reference to the live set, not a snapshot. Therefore any modification you make
to the returned set will be present inside the object. This is why there is no set
method for the
modlet includes property.
createModletInclude()
public NameType createModletInclude()
modletInclude
element instance.
modletInclude
element instance.getModletIncludes()
public Set<NameType> getModletExcludes()
This accessor method returns a reference to the live set, not a snapshot. Therefore any modification you make
to the returned set will be present inside the object. This is why there is no set
method for the
modlet excludes property.
createModletExclude()
public NameType createModletExclude()
modletExclude
element instance.
modletExclude
element instance.getModletExcludes()
public List<TransformerResourceType> getModletObjectStylesheetResources()
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make
to the returned list will be present inside the object. This is why there is no set
method for the
modlet object stylesheet resources property.
createModletObjectStylesheetResource()
public TransformerResourceType createModletObjectStylesheetResource()
modletObjectStylesheetResource
element instance.
modletObjectStylesheetResource
element instance.getModletObjectStylesheetResources()
public void preExecuteTask() throws org.apache.tools.ant.BuildException
execute
method prior to the executeTask
method.
preExecuteTask
in class JomcTask
org.apache.tools.ant.BuildException
- if execution fails.JomcTask.execute()
public void executeTask() throws org.apache.tools.ant.BuildException
executeTask
in class JomcTask
org.apache.tools.ant.BuildException
- if merging modlet resources fails.JomcTask.execute()
public boolean isModletIncluded(Modlet modlet)
modletIncludes
.
modlet
- The modlet to test.
true
, if modlet
is included based on property modletIncludes
.
NullPointerException
- if modlet
is null
.getModletIncludes()
public boolean isModletExcluded(Modlet modlet)
modletExcludes
.
modlet
- The modlet to test.
true
, if modlet
is excluded based on property modletExcludes
.
NullPointerException
- if modlet
is null
.getModletExcludes()
public MergeModletsTask clone()
clone
in class JomcTask
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2005-2012 The JOMC Project. All Rights Reserved. |