Package org.opencms.ade.configuration.formatters

Class CmsSharedSettingKey

java.lang.Object

org.opencms.ade.configuration.formatters.CmsSharedSettingKey

public class CmsSharedSettingKey
extends Object

A pair consisting of the include name of a setting definition and the formatter key (possibly null) for which the setting should be used, for use as a map key in a map of setting definitions.

Shared settings can either be defined generally, or just for a specific list of formatter keys in a setting definition file. In the first case, this corresponds to a single map key with the formatter key set to null, in the second case to a set of map keys with the same include name but different formatter keys pointing to the same setting definition data.

Constructor Summary

Constructors

Constructor	Description
CmsSharedSettingKey(String name, String formatterKey)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSharedSettingKey

public CmsSharedSettingKey(String name,
 String formatterKey)

Creates a new instance.

Parameters:

name - the include name of the setting definition

formatterKey - the formatter key (may be null)

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()