com.goldencode.p2j.ui

Class EhBrowseConfigKey

java.lang.Object

com.goldencode.p2j.ui.EhBrowseConfigKey

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public final class EhBrowseConfigKey
extends java.lang.Object
implements java.io.Externalizable

Enhanced browse configuration key. Extends BrowseKey with the field containing a user name. Used for keying configurations loaded from the directory.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
BrowseKey	configKey Key that uniquely identifies browse in an application.
java.lang.String	userName Name of the user for whom this configuration is stored.

Constructor Summary

Constructors

Constructor and Description
EhBrowseConfigKey() Default constructor
EhBrowseConfigKey(java.lang.String userName, BrowseKey configKey) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compare two instances.
int	hashCode() Return a hash code for this object.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
java.lang.String	toString() Create a string representation of this key, primarily for debug purposes.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

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

Field Detail

userName

public java.lang.String userName

Name of the user for whom this configuration is stored. null if it is applicable to all users.

configKey

public BrowseKey configKey

Key that uniquely identifies browse in an application.

Constructor Detail

EhBrowseConfigKey

public EhBrowseConfigKey()

Default constructor

EhBrowseConfigKey

public EhBrowseConfigKey(java.lang.String userName,
                         BrowseKey configKey)

Constructor.

Parameters:

userName - Name of the user for whom this configuration is stored. null if it is applicable to all users.

configKey - Key that uniquely identifies browse in an application.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compare two instances.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object to compare with.

Returns:

true if the two keys are identical.

hashCode

public int hashCode()

Return a hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code for this object.

toString

public java.lang.String toString()

Create a string representation of this key, primarily for debug purposes.

Overrides:

toString in class java.lang.Object

Returns:

string representation of this key.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - Input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.