org.pepstock.charba.client.plugins

Class PluginIdChecker

java.lang.Object

org.pepstock.charba.client.plugins.PluginIdChecker

public final class PluginIdChecker
extends java.lang.Object

This utility checks if the plug ID is acceptable or not.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
static void	check(java.lang.String id) Checks if the plugin is compliant with the constraints of plugin id. A plugin id can not start with a dot or an underscore can not contain any non-URL-safe characters cannot contain uppercase letters should be something short, but also reasonably descriptive
static Key	key(java.lang.String id) Checks if the plugin is compliant with the constraints of plugin id. A plugin id can not start with a dot or an underscore can not contain any non-URL-safe characters cannot contain uppercase letters should be something short, but also reasonably descriptive

Methods inherited from class java.lang.Object

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

Method Detail

check

public static void check(java.lang.String id)
                  throws InvalidPluginIdException

Checks if the plugin is compliant with the constraints of plugin id.
A plugin id

• can not start with a dot or an underscore
• can not contain any non-URL-safe characters
• cannot contain uppercase letters
• should be something short, but also reasonably descriptive

Parameters:

id - plugin id to be checked.

Throws:

InvalidPluginIdException - if the plugin is not compliant

key

public static Key key(java.lang.String id)
               throws InvalidPluginIdException

Checks if the plugin is compliant with the constraints of plugin id.
A plugin id

• can not start with a dot or an underscore
• can not contain any non-URL-safe characters
• cannot contain uppercase letters
• should be something short, but also reasonably descriptive

Parameters:

id - plugin id to be checked.

Throws:

InvalidPluginIdException - if the plugin is not compliant