StringResource (FreeCol Code Documentation)

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

public class StringResource
extends Resource

A Resource wrapping an String.

See Also:: Resource

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 java.lang.String data

static java.lang.String REPLACEMENT_STRING

Constructor Summary

Constructors
Constructor Description

StringResource(java.lang.String primaryKey, java.net.URI resourceLocator)
Do not use directly.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getString()`	Gets the `String` 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
  - REPLACEMENT_STRING
```
public static final java.lang.String REPLACEMENT_STRING
```
    See Also:
    
    Constant Field Values
  - data
```
private java.lang.String data
```
- Constructor Detail
  - StringResource
```
public StringResource(java.lang.String primaryKey,
                      java.net.URI resourceLocator)
```
    Do not use directly.
    
    Parameters:
    
    primaryKey - The primary key.
    
    resourceLocator - The URI used when loading this resource.
- Method Detail
  - preload
```
public void preload()
```
    Preload the resource if possible/meaningful.
    
    Specified by:
    
    preload in class Resource
  - getString
```
public java.lang.String getString()
```
    Gets the String represented by this resource.
    
    Returns:
    
    The string resource.