com.atlassian.confluence.api.model.plugin

Class ModuleCompleteKey

java.lang.Object

com.atlassian.confluence.api.model.plugin.ModuleCompleteKey

@ExperimentalApi
public final class ModuleCompleteKey
extends Object

Represents the fully qualified key of a plugin module.

The complete key is the combination of the plugin key and the "simple" module key. For example if the plugin key is "com.acme.myplugin" and the module key is "my-foo-module", then the complete key is "com.acme.myplugin:my-foo-module".

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ModuleCompleteKey(String completeKey) Constructs a ModuleCompleteKey given the String representation of the complete key.
ModuleCompleteKey(String pluginKey, String moduleKey) Constructs a ModuleCompleteKey given the separate plugin key and module key.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCompleteKey() Returns the String representation of the complete key.
String	getModuleKey() Returns the "simple" module key.
String	getPluginKey() Returns the plugin key.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

ModuleCompleteKey

public ModuleCompleteKey(String completeKey)

Constructs a ModuleCompleteKey given the String representation of the complete key. The String representation includes the plugin key, followed by a ':', followed by the simple module key.

Parameters:

completeKey - the String representation of the complete key

ModuleCompleteKey

public ModuleCompleteKey(String pluginKey,
                         String moduleKey)

Constructs a ModuleCompleteKey given the separate plugin key and module key.

Parameters:

pluginKey - the plugin key

moduleKey - the module key

Method Detail

getModuleKey

public String getModuleKey()

Returns the "simple" module key. This is the second half of the "complete" key.

Returns:

the simple module key.

getPluginKey

public String getPluginKey()

Returns the plugin key. This is the first half of the "complete" key.

Returns:

the plugin key.

getCompleteKey

public String getCompleteKey()

Returns the String representation of the complete key. This includes the plugin key, followed by a ':', followed by the simple module key.

Returns:

the String representation of the complete key.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object