org.scripthelper.model

Class ScriptSource

java.lang.Object

org.scripthelper.model.ScriptSource

All Implemented Interfaces:

java.lang.Comparable<ScriptSource>

public class ScriptSource
extends java.lang.Object
implements java.lang.Comparable<ScriptSource>

Represents a script source, which can be a string content or a file.

Since:

1.5

Constructor Summary

Constructors

Constructor and Description
ScriptSource(java.io.File file) Constructor.
ScriptSource(java.lang.String content) Constructor.
ScriptSource(java.lang.String content, java.lang.String name) Constructor.
ScriptSource(java.net.URL url) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ScriptSource source) Compares this ScriptSource with another ScriptSource.
static ScriptSource	create(java.io.File file) Create a ScriptSource with a File.
static ScriptSource	create(java.lang.String name) Create a ScriptSource with a name and a null content.
static ScriptSource	create(java.net.URL url) Create a ScriptSource with an URL.
boolean	equals(java.lang.Object obj)
java.lang.String	getAbsolutePath() Return the absolute path of the source.
java.io.BufferedReader	getBufferedReader() Return a BufferedReader on the source.
java.io.File	getFile() Return the File content of the source.
java.lang.String	getFileName() Return the name of the source.
java.lang.String	getFileNameBody() Return the body name of the source (before the extension if there is an extension, else this is the name of the file itself).
java.lang.String	getPath() Return the path of the source.
java.lang.String	getScriptContent() Return the String content of the source.
java.net.URL	getURL() Return the URL content of the source.
int	hashCode()
boolean	isFile() Return true for a file source.
void	setScriptContent(java.lang.String content) Return the String content of the source.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptSource

public ScriptSource(java.net.URL url)

Constructor.

Parameters:

url - the script URL

ScriptSource

public ScriptSource(java.io.File file)

Constructor.

Parameters:

file - the script file

ScriptSource

public ScriptSource(java.lang.String content)

Constructor.

Parameters:

content - the script text content

ScriptSource

public ScriptSource(java.lang.String content,
                    java.lang.String name)

Constructor.

Parameters:

content - the script text content

name - the script name

Method Detail

create

public static final ScriptSource create(java.lang.String name)

Create a ScriptSource with a name and a null content.

Parameters:

name - the ScriptSource name

Returns:

the ScriptSource

create

public static final ScriptSource create(java.net.URL url)

Create a ScriptSource with an URL.

Parameters:

url - the ScriptSource url

Returns:

the ScriptSource

create

public static final ScriptSource create(java.io.File file)

Create a ScriptSource with a File.

Parameters:

file - the ScriptSource File

Returns:

the ScriptSource

getFile

public java.io.File getFile()

Return the File content of the source. Will only be not null if the content is a File.

Returns:

the File content of the source

getURL

public java.net.URL getURL()

Return the URL content of the source. Will only be not null if the content is a File.

Returns:

the URL content of the source

getAbsolutePath

public java.lang.String getAbsolutePath()

Return the absolute path of the source.

Returns:

the absolute path of the source

getPath

public java.lang.String getPath()

Return the path of the source.

Returns:

the path of the source

setScriptContent

public void setScriptContent(java.lang.String content)

Return the String content of the source. Will do nothing if isFile() returens true.

Parameters:

content - the String content of the source

getScriptContent

public java.lang.String getScriptContent()

Return the String content of the source.

Returns:

the String content of the source

isFile

public boolean isFile()

Return true for a file source.

Returns:

true for a file source

getFileName

public java.lang.String getFileName()

Return the name of the source.

Returns:

the name of the source

getFileNameBody

public java.lang.String getFileNameBody()

Return the body name of the source (before the extension if there is an extension, else this is the name of the file itself).

Returns:

the body name of the source

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(ScriptSource source)

Compares this ScriptSource with another ScriptSource. Returns a negative integer, zero, or a positive integer as this ScriptSource is less than, equal to, or greater than the specified ScriptSource.

Algorithm

• If this ScriptSource is a file, and the other ScriptSource is not a file, return -1
• If this ScriptSource is not a file, and the other ScriptSource is a file, return 1
• If both ScriptSources are not files, compare the names
• If both ScriptSources are files, compare the files pathnames

Specified by:

compareTo in interface java.lang.Comparable<ScriptSource>

Parameters:

source - the ScriptSource to be compared.

Returns:

a negative integer, zero, or a positive integer as this ScriptSource is less than, equal to, or greater than the specified ScriptSource

getBufferedReader

public java.io.BufferedReader getBufferedReader()
                                         throws java.io.IOException

Return a BufferedReader on the source.

Returns:

the BufferedReader

Throws:

java.io.IOException