com.atlassian.gadgets.opensocial.model
Class PersonId

java.lang.Object
  extended by com.atlassian.gadgets.opensocial.model.PersonId

@Immutable
public final class PersonId
extends Object

Representation of the unique identifier for a person. This ID must be nonempty and may only contain alphanumeric characters, underscore, dot, or dash, and must uniquely identify the person in the container (see http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/OpenSocial-Specification.html#rfc.section.4.1.1.1)

Since:
2.0

Constructor Summary
PersonId(String id)
          Creates a new PersonId that wraps the id passed in
 
Method Summary
 boolean equals(Object o)
           
 int hashCode()
           
 String toString()
           
 String value()
          Returns the value of the identifier as a String.
static PersonId valueOf(String id)
          Convert the String value to a PersonId object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PersonId

public PersonId(String id)
Creates a new PersonId that wraps the id passed in

Parameters:
id - the String id stored internally
Method Detail

value

public String value()
Returns the value of the identifier as a String.

Returns:
the value of the identifier as a String

toString

public String toString()
Overrides:
toString in class Object

valueOf

public static PersonId valueOf(String id)
Convert the String value to a PersonId object.

Parameters:
id - String value to use
Returns:
PersonId with the underlying value of id

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2009 Atlassian. All Rights Reserved.