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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear() Forgets all cached elements.
@NotNull java.util.Collection<java.lang.String>	getNames() Returns all defined names.
void	insert(@NotNull java.lang.String name, T t) Adds a new element to the cache.
@NotNull java.util.Iterator<T>	iterator() Returns all stored values.
T	lookup(@NotNull java.lang.String name) Looks up an element by name.
T	lookupOptional(@NotNull 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

Constructor Detail

JXCSkinCache

public JXCSkinCache(@NotNull
                    @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
                   @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

lookup

@NotNull
public T lookup(@NotNull
                         @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

getNames

@NotNull
public @NotNull java.util.Collection<java.lang.String> getNames()

Returns all defined names.

Returns:

the names in alphabetical order

lookupOptional

@Nullable
public T lookupOptional(@NotNull
                                  @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

iterator

@NotNull
public @NotNull 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