Package com.sun.enterprise.admin.servermgmt.stringsubs

Interface Substitutable

All Known Subinterfaces:

ArchiveMember

All Known Implementing Classes:

ArchiveMemberHandler, FileSubstitutionHandler, LargeFileSubstitutionHandler, SmallFileSubstitutionHandler

public interface Substitutable

Defines the creation of Reader invalid input: '&' Writer for a file on which string substitution has to be performed.

Method Summary

Modifier and Type	Method	Description
void	finish()	Called at the completion of the substitution process to perform post operation.
String	getName()	Gets the processing entity name on which string substitution operation is carrying on.
Reader	getReader()	Gets the character stream from the input.
Writer	getWriter()	Gets the Writer object to write the character stream in to the output.

Method Details

getName

String getName()

Gets the processing entity name on which string substitution operation is carrying on.

Returns:

Name of the entity.

getReader

Reader getReader()

Gets the character stream from the input.

Implementation note: It is a good idea for the input stream to be buffered.

Returns:

A Reader.

getWriter

Writer getWriter()

Gets the Writer object to write the character stream in to the output.

Implementation note: It is a good idea for the output stream to be buffered.

Returns:

A Writer.

finish

void finish()

Called at the completion of the substitution process to perform post operation. For e.g closing of reader/writer, cleaning of the temporary data... etc.