com.realtime.crossfire.jxclient.skin.skin

Class JXCSkinCache<T>

java.lang.Object

com.realtime.crossfire.jxclient.skin.skin.JXCSkinCache<T>

Type Parameters:

T - the type of the cached elements

All Implemented Interfaces:

java.lang.Iterable<T>

public class JXCSkinCache<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Implements a cache for elements identified by name.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,T>	cache The cached elements.
private java.lang.String	ident The description of this cache used for creating error messages.

Constructor Summary

Constructors

Constructor and Description
JXCSkinCache(java.lang.String ident) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	clear() Forgets all cached elements.
void	insert(java.lang.String name, T t) Adds a new element to the cache.
java.util.Iterator<T>	iterator() Returns all stored values.
T	lookup(java.lang.String name) Looks up an element by name.
T	lookupOptional(java.lang.String name) Looks up an element by name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

cache

@NotNull
private final java.util.Map<java.lang.String,T> cache

The cached elements. Maps element name to element. Mapped elements are never null.

ident

@NotNull
private final java.lang.String ident

The description of this cache used for creating error messages.

Constructor Detail

JXCSkinCache

public JXCSkinCache(@NotNull
                    java.lang.String ident)

Creates a new instance.

Parameters:

ident - the description of this cache used for creating error messages

Method Detail

clear

public void clear()

Forgets all cached elements.

insert

public void insert(@NotNull
                   java.lang.String name,
                   @NotNull
                   T t)
            throws JXCSkinException

Adds a new element to the cache.

Parameters:

name - the element name to add

t - the element to add

Throws:

JXCSkinException - if the element name is not unique

iterator

@NotNull
public java.util.Iterator<T> iterator()

Returns all stored values.

Specified by:

iterator in interface java.lang.Iterable<T>

Returns:

an (read-only) iterator returning all stored values

lookup

@NotNull
public T lookup(@NotNull
                         java.lang.String name)
                  throws JXCSkinException

Looks up an element by name.

Parameters:

name - the name of the element

Returns:

the element

Throws:

JXCSkinException - if no such element exists

lookupOptional

@Nullable
public T lookupOptional(@NotNull
                                  java.lang.String name)

Looks up an element by name.

Parameters:

name - the name of the element

Returns:

the element or null if no such element exists