Java Doc for TimeUnit.java in  » Apache-Harmony-Java-SE » java-package » java » util » concurrent » 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.concurrent 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.concurrent.TimeUnit

TimeUnit
public enum TimeUnit (Code)
A TimeUnit represents time durations at a given unit of granularity and provides utility methods to convert across units, and to perform timing and delay operations in these units. A TimeUnit does not maintain time information, but only helps organize and use time representations that may be maintained separately across various contexts.

A TimeUnit is mainly used to inform time-based methods how a given timing parameter should be interpreted. For example, the following code will timeout in 50 milliseconds if the java.util.concurrent.locks.Lock lock is not available:

  Lock lock = ...;
 if ( lock.tryLock(50L, TimeUnit.MILLISECONDS) ) ...
 
while this code will timeout in 50 seconds:
 Lock lock = ...;
 if ( lock.tryLock(50L, TimeUnit.SECONDS) ) ...
 
Note however, that there is no guarantee that a particular timeout implementation will be able to notice the passage of time at the same granularity as the given TimeUnit.
since:
   1.5
author:
   Doug Lea


Field Summary
 Enum ConstantMICROSECONDS
    
 Enum ConstantMILLISECONDS
    
 Enum ConstantNANOSECONDS
    
 Enum ConstantSECONDS
    

Constructor Summary
 TimeUnit(int index)
    

Method Summary
public  longconvert(long duration, TimeUnit unit)
     Convert the given time duration in the given unit to this unit.
public  voidsleep(long timeout)
     Perform a Thread.sleep using this unit.
public  voidtimedJoin(Thread thread, long timeout)
     Perform a timed Thread.join using this time unit.
public  voidtimedWait(Object obj, long timeout)
     Perform a timed Object.wait using this time unit. This is a convenience method that converts timeout arguments into the form required by the Object.wait method.

For example, you could implement a blocking poll method (see BlockingQueue.poll BlockingQueue.poll ) using:

  public synchronized  Object poll(long timeout, TimeUnit unit) throws InterruptedException {
 while (empty) {
 unit.timedWait(this, timeout);
 ...
 }
 }

Parameters:
  obj - the object to wait on
Parameters:
  timeout - the maximum time to wait.
public  longtoMicros(long duration)
     Equivalent to MICROSECONDS.convert(duration, this).
public  longtoMillis(long duration)
     Equivalent to MILLISECONDS.convert(duration, this).
public  longtoNanos(long duration)
     Equivalent to NANOSECONDS.convert(duration, this).
public  longtoSeconds(long duration)
     Equivalent to SECONDS.convert(duration, this).

Field Detail
MICROSECONDS
Enum Constant MICROSECONDS(Code)



MILLISECONDS
Enum Constant MILLISECONDS(Code)



NANOSECONDS
Enum Constant NANOSECONDS(Code)



SECONDS
Enum Constant SECONDS(Code)




Constructor Detail
TimeUnit
TimeUnit(int index)(Code)
Internal constructor




Method Detail
convert
public long convert(long duration, TimeUnit unit)(Code)
Convert the given time duration in the given unit to this unit. Conversions from finer to coarser granularities truncate, so lose precision. For example converting 999 milliseconds to seconds results in 0. Conversions from coarser to finer granularities with arguments that would numerically overflow saturate to Long.MIN_VALUE if negative or Long.MAX_VALUE if positive.
Parameters:
  duration - the time duration in the given unit
Parameters:
  unit - the unit of the duration argument the converted duration in this unit,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.



sleep
public void sleep(long timeout) throws InterruptedException(Code)
Perform a Thread.sleep using this unit. This is a convenience method that converts time arguments into the form required by the Thread.sleep method.
Parameters:
  timeout - the minimum time to sleep
throws:
  InterruptedException - if interrupted while sleeping.
See Also:   Thread.sleep



timedJoin
public void timedJoin(Thread thread, long timeout) throws InterruptedException(Code)
Perform a timed Thread.join using this time unit. This is a convenience method that converts time arguments into the form required by the Thread.join method.
Parameters:
  thread - the thread to wait for
Parameters:
  timeout - the maximum time to wait
throws:
  InterruptedException - if interrupted while waiting.
See Also:   Thread.join(longint)



timedWait
public void timedWait(Object obj, long timeout) throws InterruptedException(Code)
Perform a timed Object.wait using this time unit. This is a convenience method that converts timeout arguments into the form required by the Object.wait method.

For example, you could implement a blocking poll method (see BlockingQueue.poll BlockingQueue.poll ) using:

  public synchronized  Object poll(long timeout, TimeUnit unit) throws InterruptedException {
 while (empty) {
 unit.timedWait(this, timeout);
 ...
 }
 }

Parameters:
  obj - the object to wait on
Parameters:
  timeout - the maximum time to wait.
throws:
  InterruptedException - if interrupted while waiting.
See Also:   Object.wait(longint)



toMicros
public long toMicros(long duration)(Code)
Equivalent to MICROSECONDS.convert(duration, this).
Parameters:
  duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also:   TimeUnit.convert



toMillis
public long toMillis(long duration)(Code)
Equivalent to MILLISECONDS.convert(duration, this).
Parameters:
  duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also:   TimeUnit.convert



toNanos
public long toNanos(long duration)(Code)
Equivalent to NANOSECONDS.convert(duration, this).
Parameters:
  duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also:   TimeUnit.convert



toSeconds
public long toSeconds(long duration)(Code)
Equivalent to SECONDS.convert(duration, this).
Parameters:
  duration - the duration the converted duration.
See Also:   TimeUnit.convert



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