FileSubstitutionHandler (Payara Project 6.2023.2 API)

java.lang.Object
- com.sun.enterprise.admin.servermgmt.stringsubs.impl.FileSubstitutionHandler

All Implemented Interfaces:

Substitutable

Direct Known Subclasses:

LargeFileSubstitutionHandler, SmallFileSubstitutionHandler
```
public abstract class FileSubstitutionHandler
extends Object
implements Substitutable
```
Abstract class initialize the input file for the string substitution. The sub-classes provides the way to create the Reader and Writer for the input & output file.

Field Summary

Fields
Modifier and Type	Field	Description
`protected File`	`inputFile`	Input file.
`protected static Logger`	`LOGGER`
`protected Reader`	`reader`	A `Reader` to read the character stream from input file.
`protected static LocalStringsImpl`	`STRINGS`
`protected Writer`	`writer`	A `Writer` to write the character stream to the output file.

Constructor Summary

Constructors
Constructor Description

FileSubstitutionHandler(File file)

Method Summary

All Methods Instance Methods Concrete Methods
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.

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

Methods inherited from interface com.sun.enterprise.admin.servermgmt.stringsubs.Substitutable
getReader, getWriter

- Field Detail
  - LOGGER
```
protected static final Logger LOGGER
```
  - STRINGS
```
protected static final LocalStringsImpl STRINGS
```
  - reader
```
protected Reader reader
```
    A Reader to read the character stream from input file.
  - writer
```
protected Writer writer
```
    A Writer to write the character stream to the output file.
  - inputFile
```
protected File inputFile
```
    Input file.
- Constructor Detail
  - FileSubstitutionHandler
```
public FileSubstitutionHandler(File file)
                        throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: Substitutable
    
    Gets the processing entity name on which string substitution operation is carrying on.
    
    Specified by:
    
    getName in interface Substitutable
    
    Returns:
    
    Name of the entity.
  - finish
```
public void finish()
```
    Description copied from interface: Substitutable
    
    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.
    
    Specified by:
    
    finish in interface Substitutable