Package net.sf.gridarta.model.face

Class AbstractFaceObjects

java.lang.Object

net.sf.gridarta.model.data.AbstractNamedObjects<FaceObject>

net.sf.gridarta.model.face.AbstractFaceObjects

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<FaceObject>, NamedObjects<FaceObject>, FaceObjects

Direct Known Subclasses:

DefaultFaceObjects

public abstract class AbstractFaceObjects
extends AbstractNamedObjects<FaceObject>
implements FaceObjects

Abstract base class for FaceObjects implementations.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFaceObjects(@NotNull java.lang.String name)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addFaceObject(@NotNull java.lang.String faceName, @NotNull java.lang.String originalFilename, int offset, int size)	Adds a new face object.

Methods inherited from class net.sf.gridarta.model.data.AbstractNamedObjects

containsKey, get, getName, getTreeRoot, iterator, put, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.gridarta.model.face.FaceObjects

isIncludeFaceNumbers, loadFacesCollection

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.sf.gridarta.model.data.NamedObjects

containsKey, get, getName, getTreeRoot, iterator, size

Constructor Detail

AbstractFaceObjects

protected AbstractFaceObjects(@NotNull
                              @NotNull java.lang.String name)

Creates a new instance.

Parameters:

name - localized name of the object type, e.g. used in dialogs

Method Detail

addFaceObject

public void addFaceObject(@NotNull
                          @NotNull java.lang.String faceName,
                          @NotNull
                          @NotNull java.lang.String originalFilename,
                          int offset,
                          int size)
                   throws DuplicateFaceException,
                          IllegalFaceException

Description copied from interface: FaceObjects

Adds a new face object.

Specified by:

addFaceObject in interface FaceObjects

Parameters:

faceName - the name of the face, e.g. "robe.101"

originalFilename - the original filename, e.g. "arch/objects/misc/robe.101.png"

offset - the offset in the file denoted by actualFilename, e.g. 148676

size - the size in the file denoted by actualFilename, e.g. 567,

Throws:

DuplicateFaceException - in case the face was not unique

IllegalFaceException - if the face cannot be added