com.physpics.tools

Class AssetsImpl

java.lang.Object

com.physpics.tools.AssetsImpl

Direct Known Subclasses:

Assets

public class AssetsImpl
extends java.lang.Object

Provide access to this package's assets. An "asset" is a file that may need to be written as well as read. The original asset file is in the project directory in distsrc/assets/asset.name. Nominally the asset file is installed into the same directory as the jar file. When saved (by calling the retain method) the asset data is stored in ~/.physpics/assets/package.name/assetname backup copies of the asset tree are in the jar file and on the webpage. In case one or more copies of the asset are absent, it is sought in another of its posible locations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetsImpl.Locations

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SLASH

Constructor Summary

Constructors

Constructor and Description
AssetsImpl()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	fetch(AssetsImpl.Locations locs, java.lang.String assetName) Fetch an asset from the most available of its sources.
static IOUtils.InfoInputStream	fetchInputStream(AssetsImpl.Locations locs, java.lang.String assetName) Fetch an InfoInputStream for an asset from the most available of its sources.
static Reader	fetchReader(AssetsImpl.Locations locs, java.lang.String assetName, java.nio.charset.Charset chset) Fetch a Reader for an asset from the most available of its sources.
static File	getRetentionFile(AssetsImpl.Locations locs, java.lang.String assetName) Get a File into which to store an asset.
static boolean	retain(AssetsImpl.Locations locs, java.lang.String assetName, java.lang.String contents) Save an asset of String type.

Methods inherited from class java.lang.Object

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

Field Detail

SLASH

public static final java.lang.String SLASH

Constructor Detail

AssetsImpl

public AssetsImpl()

Method Detail

fetch

public static java.lang.String fetch(AssetsImpl.Locations locs,
                                     java.lang.String assetName)

Fetch an asset from the most available of its sources.

Parameters:

locs - parameters for various of the possible locations

assetName - Asset's filename

Returns:

The contents of the named asset, as a string, decoded via Hybrid-UTF-8.

fetchInputStream

public static IOUtils.InfoInputStream fetchInputStream(AssetsImpl.Locations locs,
                                                       java.lang.String assetName)

Fetch an InfoInputStream for an asset from the most available of its sources.

Parameters:

locs - parameters for various of the possible locations

assetName - Asset's filename

Returns:

An InfoInputStream reading the named asset

fetchReader

public static Reader fetchReader(AssetsImpl.Locations locs,
                                 java.lang.String assetName,
                                 java.nio.charset.Charset chset)

Fetch a Reader for an asset from the most available of its sources.

Parameters:

locs - parameters for various of the possible locations

assetName - Asset's filename

chset - The character set to use. null means UTF-8

Returns:

An InputStream reading the named asset

getRetentionFile

public static File getRetentionFile(AssetsImpl.Locations locs,
                                    java.lang.String assetName)

Get a File into which to store an asset. This location will be the first place that fetch looks to find the asset. Usually it will be ~/.physpics/assets/{package.dotted.name}/{assetName} If that directory or file cannot be created the location will be {jardir}/assets/{package.dotted.name}/{assetName} If the file is locked because some other process is using it, the write will fail.

Parameters:

locs - parameters for various of the possible locations

assetName - Asset's filename

Returns:

A File for the asset to be written to. Or null if there is no suitable file.

retain

public static boolean retain(AssetsImpl.Locations locs,
                             java.lang.String assetName,
                             java.lang.String contents)

Save an asset of String type. Tries first ~/.physpics/assets and then jardir:/assets/. Encoding UTF-8. For some other encoding, save into the file given by getRetentionFile.

Parameters:

locs - parameters for various of the possible locations

assetName - Asset's filename

contents - the file contents

Returns:

true if file saved