jautil.avatar

Interface AvatarAccess

All Known Implementing Classes:

BaseAccess, CacheableAccess, ClassPathAccess, DirectFilesAccess

public interface AvatarAccess

Interface defining access to the data files needed to work with a JARP avatar. The XML files associated with the avatar are presented as raw byte arrays whose encoding (typically UTF-8) is assumed to be determinable either through an initial XML declaration or through some external means.

Method Summary

Modifier and Type	Method and Description
byte[]	asdData() Returns the avatar's ASD XML file (asd.xml) as a byte array.
java.io.InputStream	avatarDefStream() Returns an input stream for the data in the ARP avatar definition file for this avatar (avatardef.jarp or avatardef.jarp).
java.lang.String	avatarDefURL() Returns the URL for the ARP avatar definition file for this avatar (avatardef.jarp or avatardef.jarp).
java.lang.String	avatarName() The avatar name.
java.lang.String	baseURL() The base URL for the directory containing the avatar data files.
byte[]	configData() Returns the avatar's animgen configuration data XML file (config.xml) as a byte array.
byte[]	nonmanualsData() Returns the avatar's nonmanuals XML file (nonmanuals.xml) as a byte array.
void	terminateAccess() Performs any necessary termination actions for this avatar access, for example releasing any temporary files or other resources associated with it.

Method Detail

avatarName

java.lang.String avatarName()

The avatar name.

baseURL

java.lang.String baseURL()

The base URL for the directory containing the avatar data files.

asdData

byte[] asdData()

Returns the avatar's ASD XML file (asd.xml) as a byte array.

configData

byte[] configData()

Returns the avatar's animgen configuration data XML file (config.xml) as a byte array.

nonmanualsData

byte[] nonmanualsData()

Returns the avatar's nonmanuals XML file (nonmanuals.xml) as a byte array.

avatarDefStream

java.io.InputStream avatarDefStream()

Returns an input stream for the data in the ARP avatar definition file for this avatar (avatardef.jarp or avatardef.jarp).

avatarDefURL

java.lang.String avatarDefURL()

Returns the URL for the ARP avatar definition file for this avatar (avatardef.jarp or avatardef.jarp).

terminateAccess

void terminateAccess()

Performs any necessary termination actions for this avatar access, for example releasing any temporary files or other resources associated with it.