FileConfigSource (Web-Harvest Core 2.1.0 API)

java.lang.Object
- org.webharvest.definition.AbstractConfigSource
- - org.webharvest.definition.FileConfigSource

All Implemented Interfaces:

ConfigSource, HasReader
```
public final class FileConfigSource
extends AbstractConfigSource
```
Implementation of ConfigSource that uses a file system as source of XML configurations.

Since:

2.1.0-SNAPSHOT

Version:

%I%, %G%

Author:

Robert Bala

See Also:

ConfigSource, File, ConfigSource.Location

Nested Class Summary
- Nested classes/interfaces inherited from interface org.webharvest.definition.ConfigSource
  ConfigSource.Location

Field Summary
- Fields inherited from interface org.webharvest.definition.ConfigSource
  UNDEFINED_LOCATION

Constructor Summary

Constructors
Constructor Description

FileConfigSource(File file)
Class constructor expecting File as configuration source.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ConfigLocationVisitor.VisitableLocation`	`getLocation()`	Gets the reference to physical location of configuration.
`Reader`	`getReader()`	Gets the `Reader` for character stream.
`protected void`	`visit(ConfigLocationVisitor visitor)`	Depending on owned `ConfigSource.Location` allows the ancestor class to accept intercepted `ConfigLocationVisitor`.

Methods inherited from class org.webharvest.definition.AbstractConfigSource
include

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

- Constructor Detail
  - FileConfigSource
```
public FileConfigSource(File file)
```
    Class constructor expecting File as configuration source.
    
    Parameters:
    
    file - configuration source
- Method Detail
  - getReader
```
public Reader getReader()
                 throws IOException
```
    Gets the Reader for character stream.
    
    Returns:
    
    stream Reader.
    
    Throws:
    
    IOException
  - getLocation
```
public ConfigLocationVisitor.VisitableLocation getLocation()
```
    Gets the reference to physical location of configuration. (eg. URL or file path).
    
    Returns:
    
    location of configuration.
  - visit
```
protected void visit(ConfigLocationVisitor visitor)
              throws IOException
```
    Depending on owned ConfigSource.Location allows the ancestor class to accept intercepted ConfigLocationVisitor.
    
    Specified by:
    
    visit in class AbstractConfigSource
    
    Parameters:
    
    visitor - reference to ConfigLocationVisitor
    
    Throws:
    
    IOException - in case of any problem with inclusion of ConfigSource .