fr.sii.ogham.core.resource

Class FileResource

java.lang.Object

fr.sii.ogham.core.resource.FileResource

All Implemented Interfaces:

NamedResource, Resource

public class FileResource
extends Object
implements NamedResource

Resource that provide access to a file.

Author:

Aurélien Baudet

Constructor Summary

Constructors

Constructor and Description
FileResource(File file) Initialize the resource with the provided file.
FileResource(File file, String name) Initialize the resource with the provided file and name.
FileResource(String fileName) Initialize the resource with the provided file.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
File	getFile()
InputStream	getInputStream() Stream that contains the template content.
String	getName() Get the name for the resource.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileResource

public FileResource(File file,
                    String name)

Initialize the resource with the provided file and name. The file is the content of the resource. Use the provided name for the resource name instead of the name of the file.

Parameters:

file - the content of the resource

name - the name for the resource

FileResource

public FileResource(File file)

Initialize the resource with the provided file. The file is the content of the resource. Use the name of the file for the name of the resource.

Parameters:

file - the content of the resource

FileResource

public FileResource(String fileName)

Initialize the resource with the provided file. The file is the content of the resource. Use the name of the file for the name of the resource.

Parameters:

fileName - the content of the resource

Method Detail

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: Resource

Stream that contains the template content. The input stream MUST be readable several times so every time this method is called, a new InputStream is created. You MUST close the input stream after using it.

Specified by:

getInputStream in interface Resource

Returns:

an input stream that points to the template content

Throws:

IOException - when the input stream can't be accessed or read

getFile

public File getFile()

getName

public String getName()

Description copied from interface: NamedResource

Get the name for the resource.

Specified by:

getName in interface NamedResource

Returns:

the name of the resource

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object