Java Doc for UUID.java in  » Apache-Harmony-Java-SE » java-package » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Apache Harmony Java SE » java package » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.UUID

UUID
final public class UUID implements Serializable,Comparable<UUID>(Code)

UUID is an immutable representation of a 128-bit universally unique identifier (UUID).

There are multiple, variant layouts of UUIDs, but this class is based upon variant 2 of RFC 4122, the Leach-Salz variant. This class can be used to model alternate variants, but most of the methods will be unsupported in those cases; see each method for details.


since:
   1.5
author:
   Nathan Beyer (Harmony)



Constructor Summary
public  UUID(long mostSigBits, long leastSigBits)
    

Constructs an instance with the specified bits.


Method Summary
public  intclockSequence()
    

The clock sequence value of the version 1, variant 2 UUID as per RFC 4122.

public  intcompareTo(UUID uuid)
    

Compares this UUID to the specified UUID.

public  booleanequals(Object object)
    

Compares this UUID to another object for equality.

public static  UUIDfromString(String uuid)
    

Parses a UUID string with the format defined by UUID.toString() .


Parameters:
  uuid - The UUID string to parse.
public  longgetLeastSignificantBits()
    

The 64 least significant bits of the UUID.

public  longgetMostSignificantBits()
    

The 64 most significant bits of the UUID.

public  inthashCode()
    

Returns a hash value for this UUID that is consistent with the UUID.equals(Object) method.

public static  UUIDnameUUIDFromBytes(byte[] name)
    

Generates a variant 2, version 3 (name-based, MD5-hashed) UUID as per RFC 4122.

public  longnode()
    

The node value of the version 1, variant 2 UUID as per RFC 4122.

public static  UUIDrandomUUID()
    

Generates a variant 2, version 4 (randomly generated number) UUID as per RFC 4122.

public  longtimestamp()
    

The timestamp value of the version 1, variant 2 UUID as per RFC 4122.

public  StringtoString()
    

Returns a string representation of this UUID in the following format, as per RFC 4122.

public  intvariant()
    

The variant of the UUID as per RFC 4122.

public  intversion()
    

The version of the variant 2 UUID as per RFC 4122.



Constructor Detail
UUID
public UUID(long mostSigBits, long leastSigBits)(Code)

Constructs an instance with the specified bits.


Parameters:
  mostSigBits - The 64 most significant bits of the UUID.
Parameters:
  leastSigBits - The 64 least significant bits of the UUID.




Method Detail
clockSequence
public int clockSequence()(Code)

The clock sequence value of the version 1, variant 2 UUID as per RFC 4122.

A long value.
throws:
  UnsupportedOperationException - if UUID.version() is not 1.



compareTo
public int compareTo(UUID uuid)(Code)

Compares this UUID to the specified UUID. The natural ordering of UUIDs is based upon the value of the bits from most significant to least significant.


Parameters:
  uuid - The UUID to compare to. A value of -1, 0 or 1 if this UUID is less than, equal to orgreater than uuid.



equals
public boolean equals(Object object)(Code)

Compares this UUID to another object for equality. If object is not null, a UUID instance and all bits are equals, then true is returned.


Parameters:
  object - The Object to compare to. A true if this UUID is equal toobject or false if not.



fromString
public static UUID fromString(String uuid)(Code)

Parses a UUID string with the format defined by UUID.toString() .


Parameters:
  uuid - The UUID string to parse. A UUID instance.
throws:
  NullPointerException - if uuid is null.
throws:
  IllegalArgumentException - if uuid is not formatted correctly.



getLeastSignificantBits
public long getLeastSignificantBits()(Code)

The 64 least significant bits of the UUID.

A long value.



getMostSignificantBits
public long getMostSignificantBits()(Code)

The 64 most significant bits of the UUID.

A long value.



hashCode
public int hashCode()(Code)

Returns a hash value for this UUID that is consistent with the UUID.equals(Object) method.

An int value.



nameUUIDFromBytes
public static UUID nameUUIDFromBytes(byte[] name)(Code)

Generates a variant 2, version 3 (name-based, MD5-hashed) UUID as per RFC 4122.

A UUID instance.



node
public long node()(Code)

The node value of the version 1, variant 2 UUID as per RFC 4122.

A long value.
throws:
  UnsupportedOperationException - if UUID.version() is not 1.



randomUUID
public static UUID randomUUID()(Code)

Generates a variant 2, version 4 (randomly generated number) UUID as per RFC 4122.

A UUID instance.



timestamp
public long timestamp()(Code)

The timestamp value of the version 1, variant 2 UUID as per RFC 4122.

A long value.
throws:
  UnsupportedOperationException - if UUID.version() is not 1.



toString
public String toString()(Code)

Returns a string representation of this UUID in the following format, as per RFC 4122.

 UUID                   = time-low "-" time-mid "-"
 time-high-and-version "-"
 clock-seq-and-reserved
 clock-seq-low "-" node
 time-low               = 4hexOctet
 time-mid               = 2hexOctet
 time-high-and-version  = 2hexOctet
 clock-seq-and-reserved = hexOctet
 clock-seq-low          = hexOctet
 node                   = 6hexOctet
 hexOctet               = hexDigit hexDigit
 hexDigit =
 "0" / "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9" /
 "a" / "b" / "c" / "d" / "e" / "f" /
 "A" / "B" / "C" / "D" / "E" / "F"
 
A String instance.



variant
public int variant()(Code)

The variant of the UUID as per RFC 4122.

  • 0 - Reserved for NCS compatibility
  • 2 - RFC 4122/Leach-Salz
  • 6 - Reserved for Microsoft Corporation compatibility
  • 7 - Reserved for future use
An int value.



version
public int version()(Code)

The version of the variant 2 UUID as per RFC 4122. If the variant is not 2, then the version will be 0.

An int value.



Methods inherited from java.lang.Object
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object object)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final public Class<? extends Object> getClass()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
final public void notify()(Code)(Java Doc)
final public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final public void wait(long millis, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait(long millis) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.