net.shibboleth.metadata

Class ItemId

java.lang.Object

net.shibboleth.metadata.ItemId

All Implemented Interfaces:

Serializable, Comparable<ItemId>, ItemMetadata

@ThreadSafe
public class ItemId
extends Object
implements ItemMetadata, Comparable<ItemId>

Carries a unique identifier for the data carried by an Item. An Item may have more than one ItemId, but should not have the same ItemId as any other Item in a given context.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private String	id Unique ID for the Item.
private static long	serialVersionUID Serial version UID.

Constructor Summary

Constructors

Constructor and Description
ItemId(String itemId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ItemId o)
boolean	equals(Object obj)
String	getId() Gets a unique identifier for the data carried by the Item.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version UID.

See Also:

Constant Field Values

id

private String id

Unique ID for the Item.

Constructor Detail

ItemId

public ItemId(@Nonnull@NotEmpty
      String itemId)

Constructor.

Parameters:

itemId - a unique identifier for the entity, never null

Method Detail

getId

@Nonnull
public String getId()

Gets a unique identifier for the data carried by the Item.

Returns:

unique identifier for the data carried by the Item

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ItemId o)

Specified by:

compareTo in interface Comparable<ItemId>