|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rational.rpe.api.docspec.RPEDocumentElement
com.ibm.rational.rpe.api.docspec.RPERuntime
public class RPERuntime
Runtime configuration for a RPEDocumentSpecification
object. This
class is usually used to retrieve the templates or outputs defined by a
Document Specification.
Constructor Summary | |
---|---|
RPERuntime()
|
Method Summary | |
---|---|
void |
accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v)
|
void |
addLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
Adds a log to the runtime section. |
void |
addOutput(RPEOutput out)
Adds an output to the runtime section. |
void |
addTemplate(RPETemplate templ)
Adds a template to the runtime information. |
com.ibm.rational.rpe.api.docspec.RPELogging |
getLog(java.lang.String logName)
Retrieves a log elements by its name. |
java.util.List<com.ibm.rational.rpe.api.docspec.RPELogging> |
getLogs()
Retrieves the logs associated with the runtime. |
RPEMetadata |
getMetadata()
Retrieves the metadata associated with the runtime section. |
RPEOutput |
getOutput(java.lang.String outputPath)
Retrieves the output with a given path. |
int |
getOutputPosition(RPEOutput output)
Retrieves the output position. |
java.util.List<RPEOutput> |
getOutputs()
Retrieves the outputs from the runtime section. |
RPETemplate |
getTemplate(java.lang.String templName)
Retrieves a template with a given name. |
int |
getTemplatePosition(RPETemplate templ)
Retrieves the position of a template. |
java.util.List<RPETemplate> |
getTemplates()
Retrieves the list of templates associated with a Document Specification. |
void |
removeLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
Removes a log from the runtime section. |
void |
removeOutput(RPEOutput output)
Removes an output from the runtime section. |
void |
removeTemplate(RPETemplate templ)
Removes a template from the runtime information. |
void |
setMetadata(RPEMetadata metadata)
Sets the metadata for the runtime section. |
void |
setOutputPosition(RPEOutput output,
int position)
Sets the position of an output in the runtime section. |
void |
setTemplatePosition(RPETemplate templ,
int position)
Sets a template position in the runtime section. |
Methods inherited from class com.ibm.rational.rpe.api.docspec.RPEDocumentElement |
---|
addProperties, addProperty, getProperties, getProperty, makeFeature, removeProperty |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RPERuntime()
Method Detail |
---|
public java.util.List<RPETemplate> getTemplates()
List
of RPETemplate
opublic RPETemplate getTemplate(java.lang.String templName)
templName
- the template name
public void addTemplate(RPETemplate templ)
templ
- the template to addpublic void removeTemplate(RPETemplate templ)
templ
- the template to removepublic void setTemplatePosition(RPETemplate templ, int position)
template position will start with: 0
templ
- the template for which the position will be setposition
- the new template positionpublic int getTemplatePosition(RPETemplate templ)
templ
- the template for which the position will be determined
public int getOutputPosition(RPEOutput output)
output
- the output for which the position will be determined
public void setOutputPosition(RPEOutput output, int position)
output
- the output for which position will be setposition
- the new output positionpublic java.util.List<com.ibm.rational.rpe.api.docspec.RPELogging> getLogs()
List
of RPELogging
objectspublic com.ibm.rational.rpe.api.docspec.RPELogging getLog(java.lang.String logName)
logName
- the name of the log that will be retrieved
public void addLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
log
- the log to addpublic void removeLog(com.ibm.rational.rpe.api.docspec.RPELogging log)
log
- the log to removepublic java.util.List<RPEOutput> getOutputs()
List
of RPEOutput
elementspublic RPEOutput getOutput(java.lang.String outputPath)
outputPath
- the path of the output
public void addOutput(RPEOutput out)
out
- the output to addpublic void removeOutput(RPEOutput output)
output
- the output to removepublic RPEMetadata getMetadata()
public void setMetadata(RPEMetadata metadata)
metadata
- the metadata to setpublic void accept(com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitor v) throws RPEException
accept
in interface com.ibm.rational.rpe.api.docspec.visitor.DocumentSpecificationVisitable
RPEException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |