com.realtime.crossfire.jxclient.faces

Class AbstractFacesManager

java.lang.Object

com.realtime.crossfire.jxclient.faces.AbstractFacesManager

All Implemented Interfaces:

FacesManager

Direct Known Subclasses:

DefaultFacesManager

public abstract class AbstractFacesManager
extends java.lang.Object
implements FacesManager

Abstract base class for FacesManager implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFacesManager(@NotNull FaceCache faceCache) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addFacesManagerListener(@NotNull FacesManagerListener facesManagerListener) Adds a FacesManagerListener to be notified about updated faces.
protected void	fireFaceUpdated(@NotNull Face face) Notifies all FacesManagerListeners that a face has been updated.
@NotNull Face	getFace(int faceNum) Returns the Face instance for a given face ID.
@Nullable Face	getFace2(int faceNum) Returns the Face instance for a given face ID.
protected abstract @NotNull FaceImages	getFaceImages(int faceNum, @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage) Returns the FaceImages information for a face ID.
@NotNull javax.swing.ImageIcon	getMagicMapImageIcon(int faceNum, @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage) Returns the "magic map" face for a face ID.
@NotNull javax.swing.ImageIcon	getOriginalImageIcon(int faceNum, @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage) Returns the "original" face for a face ID.
@NotNull javax.swing.ImageIcon	getScaledImageIcon(int faceNum, @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage) Returns the "scaled" face for a face ID.
protected @NotNull Face	lookupFace(int faceNum) Returns the Face instance for a given face ID.
void	removeFacesManagerListener(@NotNull FacesManagerListener facesManagerListener) Removes a FacesManagerListener to be notified about updated faces.
void	reset() Forgets about pending faces.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFacesManager

protected AbstractFacesManager(@NotNull
                               @NotNull FaceCache faceCache)

Creates a new instance.

Parameters:

faceCache - the face cache instance for storing in-memory faces

Method Detail

addFacesManagerListener

public void addFacesManagerListener(@NotNull
                                    @NotNull FacesManagerListener facesManagerListener)

Description copied from interface: FacesManager

Adds a FacesManagerListener to be notified about updated faces.

Specified by:

addFacesManagerListener in interface FacesManager

Parameters:

facesManagerListener - the listener

removeFacesManagerListener

public void removeFacesManagerListener(@NotNull
                                       @NotNull FacesManagerListener facesManagerListener)

Description copied from interface: FacesManager

Removes a FacesManagerListener to be notified about updated faces.

Specified by:

removeFacesManagerListener in interface FacesManager

Parameters:

facesManagerListener - the listener

fireFaceUpdated

protected void fireFaceUpdated(@NotNull
                               @NotNull Face face)

Notifies all FacesManagerListeners that a face has been updated.

Parameters:

face - the face

getOriginalImageIcon

@NotNull
public @NotNull javax.swing.ImageIcon getOriginalImageIcon(int faceNum,
                                                                    @Nullable
                                                                    @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage)

Description copied from interface: FacesManager

Returns the "original" face for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Specified by:

getOriginalImageIcon in interface FacesManager

Parameters:

faceNum - the face ID

returnIsUnknownImage - returns whether the returned face is the "unknown" face; ignored if null

Returns:

the face, or the "unknown" face if the face is not loaded

getScaledImageIcon

@NotNull
public @NotNull javax.swing.ImageIcon getScaledImageIcon(int faceNum,
                                                                  @Nullable
                                                                  @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage)

Description copied from interface: FacesManager

Returns the "scaled" face for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Specified by:

getScaledImageIcon in interface FacesManager

Parameters:

faceNum - the face ID

returnIsUnknownImage - returns whether the returned face is the "unknown" face; ignored if null

Returns:

the face, or the "unknown" face if the face is not loaded

getMagicMapImageIcon

@NotNull
public @NotNull javax.swing.ImageIcon getMagicMapImageIcon(int faceNum,
                                                                    @Nullable
                                                                    @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage)

Description copied from interface: FacesManager

Returns the "magic map" face for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Specified by:

getMagicMapImageIcon in interface FacesManager

Parameters:

faceNum - the face ID

returnIsUnknownImage - returns whether the returned face is the "unknown" face; ignored if null

Returns:

the face, or the "unknown" face if the face is not loaded

getFace

@NotNull
public @NotNull Face getFace(int faceNum)

Description copied from interface: FacesManager

Returns the Face instance for a given face ID. Requests the face from the server if necessary.

Specified by:

getFace in interface FacesManager

Parameters:

faceNum - the face ID to request

Returns:

the face

getFaceImages

@NotNull
protected abstract @NotNull FaceImages getFaceImages(int faceNum,
                                                              @Nullable
                                                              @Nullable java.util.concurrent.atomic.AtomicBoolean returnIsUnknownImage)

Returns the FaceImages information for a face ID. This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Parameters:

faceNum - the face ID

returnIsUnknownImage - returns whether the returned face is the "unknown" face; ignored if null

Returns:

the face images information

lookupFace

@NotNull
protected @NotNull Face lookupFace(int faceNum)

Returns the Face instance for a given face ID. Other than getFace(int), does not request the face face from the server if unknown.

Parameters:

faceNum - the face ID to look up

Returns:

the face

getFace2

@Nullable
public @Nullable Face getFace2(int faceNum)

Description copied from interface: FacesManager

Returns the Face instance for a given face ID. Requests the face from the server if necessary.

Specified by:

getFace2 in interface FacesManager

Parameters:

faceNum - the face ID to request

Returns:

the face or null for the empty face

reset

public void reset()

Description copied from interface: FacesManager

Forgets about pending faces.

Specified by:

reset in interface FacesManager