com.alee.managers.icon.set

Class AbstractIconSet

java.lang.Object

com.alee.managers.icon.set.AbstractIconSet

All Implemented Interfaces:

Identifiable, Mergeable, Overwriting, IconSet, Serializable, Cloneable

Direct Known Subclasses:

RuntimeIconSet, XmlIconSet

public abstract class AbstractIconSet
extends Object
implements IconSet, Overwriting, Cloneable, Serializable

Abstract IconSet common method implementations.

Author:

Mikle Garin

See Also:

How to use IconManager, IconSet, IconManager, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Icon>	cache Loaded Icons cache.
protected Map<String,IconSource>	iconsData IconSource cache used for loading icons lazily.
protected String	id Unique IconSet identifier.

Constructor Summary

Constructors

Constructor and Description
AbstractIconSet(String id) Constructs new AbstractIconSet.

Method Summary

Modifier and Type	Method and Description
void	addIcon(IconSource icon) Adds new Icon referenced by specified IconSource into the set.
Icon	findIcon(String id) Returns Icon for the specified identifier.
String	getId()
List<String>	getIds() Returns identifiers of all Icons in the set.
boolean	isOverwrite()

Methods inherited from class java.lang.Object

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

Field Detail

id

@NotNull
protected final String id

Unique IconSet identifier.

iconsData

@NotNull
protected final Map<String,IconSource> iconsData

IconSource cache used for loading icons lazily. It contains: Icon identifier -> IconSource.

cache

@Nullable
 @OmitOnClone
 @OmitOnMerge
protected transient Map<String,Icon> cache

Loaded Icons cache. It contains: Icon identifier -> weak reference to loaded Icon.

Constructor Detail

AbstractIconSet

public AbstractIconSet(@NotNull
                       String id)

Constructs new AbstractIconSet.

Parameters:

id - unique IconSet identifier

Method Detail

getId

@NotNull
public String getId()

Specified by:

getId in interface Identifiable

Specified by:

getId in interface IconSet

isOverwrite

public boolean isOverwrite()

Specified by:

isOverwrite in interface Overwriting

getIds

@NotNull
public List<String> getIds()

Description copied from interface: IconSet

Returns identifiers of all Icons in the set.

Specified by:

getIds in interface IconSet

Returns:

identifiers of all Icons in the set

addIcon

public void addIcon(@NotNull
                    IconSource icon)

Description copied from interface: IconSet

Adds new Icon referenced by specified IconSource into the set.

Specified by:

addIcon in interface IconSet

Parameters:

icon - IconSource of the Icon to add

findIcon

@Nullable
public Icon findIcon(@NotNull
                               String id)

Description copied from interface: IconSet

Returns Icon for the specified identifier.

Specified by:

findIcon in interface IconSet

Parameters:

id - unique Icon identifier

Returns:

Icon for the specified identifier