org.youscope.addon.skin

Interface SkinFactory

All Known Implementing Classes:

DarkSkinFactory, SkinFactoryAdapter, SystemSkinFactory

public interface SkinFactory

Factory to provide different skins for the YouScope client.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
Skin	createSkin(java.lang.String typeIdentifier) Creates a skin for the given type identifier Throws a addon exception if the type identifier is not supported.
AddonMetadata	getMetadata(java.lang.String typeIdentifier) Returns the metadata (like human readable name) for a given skin.
java.lang.String[]	getSupportedTypeIdentifiers() Returns a list of all skin type identifiers supported by this factory.
boolean	isSupportingTypeIdentifier(java.lang.String typeIdentifier) Returns true if this factory supports skins with the given ID, false otherwise.

Method Detail

createSkin

Skin createSkin(java.lang.String typeIdentifier)
         throws AddonException

Creates a skin for the given type identifier Throws a addon exception if the type identifier is not supported.

Parameters:

typeIdentifier - Type identifier of the look and feel.

Returns:

The constructed addon.

Throws:

AddonException - Thrown if an error occurred during the construction.

getSupportedTypeIdentifiers

java.lang.String[] getSupportedTypeIdentifiers()

Returns a list of all skin type identifiers supported by this factory. A type identifier is a string unique for a given look and feel type, with which the skin type is identified.

Returns:

List of supported skin types.

isSupportingTypeIdentifier

boolean isSupportingTypeIdentifier(java.lang.String typeIdentifier)

Returns true if this factory supports skins with the given ID, false otherwise.

Parameters:

typeIdentifier - The ID of the skin for which it should be queried if this factory supports its construction.

Returns:

True if this factory supports creating skins with the given ID, false otherwise.

getMetadata

AddonMetadata getMetadata(java.lang.String typeIdentifier)
                   throws AddonException

Returns the metadata (like human readable name) for a given skin.

Parameters:

typeIdentifier - The type identifier of the skin for which the metadata should be returned.

Returns:

The metadata of the given skin.

Throws:

AddonException - Thrown if identifier is not supported by the addon.