GeneratedArtefact (anotheria.net document and site generation framework 4.0.0 API)

java.lang.Object
- net.anotheria.asg.generator.GeneratedArtefact

Direct Known Subclasses:

GeneratedClass, GeneratedJSPFile, GeneratedSQLFile, GeneratedXMLFile
```
public abstract class GeneratedArtefact
extends java.lang.Object
```
Base class for artefacts generated by the ASG.

Version:

$Id: $Id

Author:

lrosenberg

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CRLF
Constant for line separator (CR + LF).

Constructor Summary

Constructors
Constructor Description

GeneratedArtefact()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`createFileContent()`	Creates the content of the file.
`abstract java.lang.StringBuilder`	`getBody()`	Returns the body of the generated artefact.
`abstract java.lang.String`	`getFileType()`	Returns the file type (i.e.
`java.lang.String`	`getName()`	Returns the name of the artefact.
`abstract java.lang.String`	`getPath()`	Returns the relative path where the artefact must be stored on the filesystem.
`void`	`setName(java.lang.String aName)`	Sets the name of the artefact.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CRLF
```
public static final java.lang.String CRLF
```
    Constant for line separator (CR + LF).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GeneratedArtefact
```
public GeneratedArtefact()
```
- Method Detail
  - createFileContent
```
public abstract java.lang.String createFileContent()
```
    Creates the content of the file.
    
    Returns:
    
    a String object.
  - getFileType
```
public abstract java.lang.String getFileType()
```
    Returns the file type (i.e. .java or .jsp).
    
    Returns:
    
    a String object.
  - getPath
```
public abstract java.lang.String getPath()
```
    Returns the relative path where the artefact must be stored on the filesystem.
    
    Returns:
    
    a String object.
  - getBody
```
public abstract java.lang.StringBuilder getBody()
```
    Returns the body of the generated artefact.
    
    Returns:
    
    a StringBuilder object.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the artefact.
    
    Returns:
    
    a String object.
  - setName
```
public void setName(java.lang.String aName)
```
    Sets the name of the artefact.
    
    Parameters:
    
    aName - a String object.