UserIndexKey (onebusaway-users 2.5.13-otsf API)

java.lang.Object
- org.onebusaway.users.model.UserIndexKey

All Implemented Interfaces:

Serializable, Comparable<UserIndexKey>
```
@Embeddable
public class UserIndexKey
extends Object
implements Serializable, Comparable<UserIndexKey>
```
A type+value tuple that uniquely identifies a UserIndex object. See UserIndexTypes for common user index type values.

Author:

bdferris

See Also:

UserIndex, UserIndexTypes, Serialized Form

Constructor Summary

Constructors
Constructor Description

UserIndexKey()

UserIndexKey(String type, String value)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(UserIndexKey o)`	`Comparator` Interface
`boolean`	`equals(Object obj)`
`String`	`getType()`
`String`	`getValue()`
`int`	`hashCode()`	`Object` Interface
`static UserIndexKey`	`parseString(String userIndexKey)`
`String`	`toString()`	It's important that this method not be changed, since the type_value form is used in serialization / de-serialization

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserIndexKey
```
public UserIndexKey()
```
  - UserIndexKey
```
public UserIndexKey(String type,
                    String value)
```
- Method Detail
  - parseString
```
public static UserIndexKey parseString(String userIndexKey)
```
  - getType
```
public String getType()
```
  - getValue
```
public String getValue()
```
  - compareTo
```
public int compareTo(UserIndexKey o)
```
    Comparator Interface
    
    Specified by:
    
    compareTo in interface Comparable<UserIndexKey>
  - hashCode
```
public int hashCode()
```
    Object Interface
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    It's important that this method not be changed, since the type_value form is used in serialization / de-serialization
    
    Overrides:
    
    toString in class Object