FAFileResource (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.common.resources.Resource
- - net.sf.freecol.common.resources.FAFileResource

```
public class FAFileResource
extends Resource
```
A Resource wrapping a FAFile.

See Also:

Resource, FAFile

Nested Class Summary
- Nested classes/interfaces inherited from class net.sf.freecol.common.resources.Resource
  Resource.Cleanable

Field Summary

Fields
Modifier and Type Field Description

private FAFile FAFile

Constructor Summary

Constructors
Modifier	Constructor	Description
	`FAFileResource(java.lang.String primaryKey, java.net.URI resourceLocator)`	Do not use directly.
`private`	`FAFileResource(java.lang.String primaryKey, FAFile FAFile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FAFile`	`getFAFile()`	Gets the `FAFile` represented by this resource.
`void`	`preload()`	Preload the resource if possible/meaningful.

Methods inherited from class net.sf.freecol.common.resources.Resource
getPrimaryKey, getResourceLocator

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

- Field Detail
  - FAFile
```
private final FAFile FAFile
```
- Constructor Detail
  - FAFileResource
```
private FAFileResource(java.lang.String primaryKey,
                       FAFile FAFile)
```
  - FAFileResource
```
public FAFileResource(java.lang.String primaryKey,
                      java.net.URI resourceLocator)
               throws java.io.IOException
```
    Do not use directly.
    
    Parameters:
    
    primaryKey - The primary key.
    
    resourceLocator - The URI used when loading this resource.
    
    Throws:
    
    java.io.IOException - if FAFile can not be opened.
- Method Detail
  - preload
```
public void preload()
```
    Preload the resource if possible/meaningful.
    
    Specified by:
    
    preload in class Resource
  - getFAFile
```
public FAFile getFAFile()
```
    Gets the FAFile represented by this resource.
    
    Returns:
    
    The FAFile for this resource, or the default Java FAFile if none found.