com.atlassian.gadgets.plugins

Class PluginGadgetSpec.Key

java.lang.Object

com.atlassian.gadgets.plugins.PluginGadgetSpec.Key

Enclosing class:

PluginGadgetSpec

public static final class PluginGadgetSpec.Key
extends Object

An immutable representation of a unique identifier for plugin gadget specs, composed of a plugin key and resource location path name.

Constructor Summary

Constructors

Constructor and Description
Key(String pluginKey, String location) Constructs a new PluginGadgetSpec.Key from the specified plugin key and resource location.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getLocation() Returns the location of the spec this key is for.
String	getPluginKey() Returns the key of the plugin that the spec this key is for is contained in.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Key

public Key(String pluginKey,
           String location)

Constructs a new PluginGadgetSpec.Key from the specified plugin key and resource location.

Parameters:

pluginKey - the plugin key of the Plugin that contains the resource. Must not be null, or a NullPointerException will be thrown.

location - the location of the resource within the plugin or the external location of the resource. Must not be null, or a NullPointerException will be thrown.

Throws:

NullPointerException - if any argument is null

Method Detail

getPluginKey

public String getPluginKey()

Returns the key of the plugin that the spec this key is for is contained in.

Returns:

the key of the plugin

getLocation

public String getLocation()

Returns the location of the spec this key is for.

Returns:

the location of the spec this key is for

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