org.tiledreader

Class FileSystemTiledReader

java.lang.Object

org.tiledreader.TiledReader

org.tiledreader.FileSystemTiledReader

public class FileSystemTiledReader
extends TiledReader

A FileSystemTiledReader is a type of TiledReader that locates and identifies resources using standard paths through the local file system, and caches resources in a HashMap with canonical path strings as keys. This is the best type of TiledReader to use if you're not doing anything fancy with file storage and not trying to integrate TiledReader with an existing asset management system.

Author:

Alex Heyman

Field Summary

Fields inherited from class org.tiledreader.TiledReader

LOGGER, TILED_VERSION, TMX_VERSION, VERSION

Constructor Summary

Constructors

Constructor and Description
FileSystemTiledReader() Constructs a new FileSystemTiledReader.

Method Summary

Modifier and Type	Method and Description
protected void	clearCachedResources() Clears the cache, causing it to no longer identify any resource by any path.
TiledResource	getCachedResource(String path) Returns the resource in the cache identified by the specified path, which must be a canonical path by the standards of getCanonicalPath().
String	getCanonicalPath(String path) Returns a version of the specified path string that is both absolute and unique.
InputStream	getInputStream(String path) Returns an InputStream that reads the file data at the location of the specified path, which must be a canonical path by the standards of getCanonicalPath().
String	joinPaths(String basePath, String relativePath) Returns a path string that points to the same location as the specified relative path does when followed from the location of the specified base path.
protected void	removeCachedResource(String path) Sets the cache to no longer identify any resource by the specified path, which must be a canonical path by the standards of getCanonicalPath().
protected void	setCachedResource(String path, TiledResource resource) Sets the cache to identify the specified resource by the specified path, which must be a canonical path by the standards of getCanonicalPath().

Methods inherited from class org.tiledreader.TiledReader

clearResources, getMap, getObjectTypes, getTemplate, getTileset, readObjectTypes, removeResource, setObjectTypes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemTiledReader

public FileSystemTiledReader()

Constructs a new FileSystemTiledReader.

Method Detail

getCanonicalPath

public final String getCanonicalPath(String path)

Description copied from class: TiledReader

Returns a version of the specified path string that is both absolute and unique. In other words, the canonical path points to the same location regardless of the program's working directory, and only one canonical path corresponds to a given location. This method works similarly to java.io.File.getCanonicalPath().

Specified by:

getCanonicalPath in class TiledReader

Parameters:

path - The path to find the canonical version of

Returns:

The canonical version of the specified path

joinPaths

public final String joinPaths(String basePath,
                              String relativePath)

Description copied from class: TiledReader

Returns a path string that points to the same location as the specified relative path does when followed from the location of the specified base path. The returned path is not necessarily canonical by the standards of getCanonicalPath(). This method works similarly to java.nio.file.Path.resolve().

Specified by:

joinPaths in class TiledReader

Parameters:

basePath - The base path

relativePath - The relative path

Returns:

A single path that points to the same location as the relative path followed from the base path

getInputStream

public final InputStream getInputStream(String path)

Description copied from class: TiledReader

Returns an InputStream that reads the file data at the location of the specified path, which must be a canonical path by the standards of getCanonicalPath().

Specified by:

getInputStream in class TiledReader

Parameters:

path - The canonical path to the file data

Returns:

An InputStream that reads from the path's location

getCachedResource

public final TiledResource getCachedResource(String path)

Description copied from class: TiledReader

Returns the resource in the cache identified by the specified path, which must be a canonical path by the standards of getCanonicalPath(). Returns null if there is no such resource.

Specified by:

getCachedResource in class TiledReader

Parameters:

path - The canonical path to the file from which the resource was read

Returns:

The resource in the cache identified by the path

setCachedResource

protected final void setCachedResource(String path,
                                       TiledResource resource)

Description copied from class: TiledReader

Sets the cache to identify the specified resource by the specified path, which must be a canonical path by the standards of getCanonicalPath(). This method must be implemented in subclasses of TiledReader, but must never be called outside of TiledReader library code.

Specified by:

setCachedResource in class TiledReader

Parameters:

path - The canonical path by which to identify the resource

resource - The resource to be identified by the path

removeCachedResource

protected final void removeCachedResource(String path)

Description copied from class: TiledReader

Sets the cache to no longer identify any resource by the specified path, which must be a canonical path by the standards of getCanonicalPath(). This method must be implemented in subclasses of TiledReader, but must never be called outside of TiledReader library code.

Specified by:

removeCachedResource in class TiledReader

Parameters:

path - The canonical path that identifies the resource to remove from the cache

clearCachedResources

protected final void clearCachedResources()

Description copied from class: TiledReader

Clears the cache, causing it to no longer identify any resource by any path. This method must be implemented in subclasses of TiledReader, but must never be called outside of TiledReader library code.

Specified by:

clearCachedResources in class TiledReader