Java Doc for Range.java in  » Library » Apache-common-lang » org » apache » commons » lang » math » 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 » Library » Apache common lang » org.apache.commons.lang.math 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.lang.math.Range

All known Subclasses:   org.apache.commons.lang.math.NumberRange,  org.apache.commons.lang.math.IntRange,  org.apache.commons.lang.math.DoubleRange,  org.apache.commons.lang.math.FloatRange,  org.apache.commons.lang.math.LongRange,
Range
abstract public class Range (Code)

Range represents a range of numbers of the same type.

Specific subclasses hold the range values as different types. Each subclass should be immutable and java.io.Serializable Serializable if possible.


author:
   Stephen Colebourne
since:
   2.0
version:
   $Id: Range.java 437554 2006-08-28 06:21:41Z bayard $



Constructor Summary
public  Range()
    

Method Summary
public  booleancontainsDouble(Number value)
    
public  booleancontainsDouble(double value)
    
public  booleancontainsFloat(Number value)
    
public  booleancontainsFloat(float value)
    
public  booleancontainsInteger(Number value)
    
public  booleancontainsInteger(int value)
    
public  booleancontainsLong(Number value)
    
public  booleancontainsLong(long value)
    
abstract public  booleancontainsNumber(Number number)
    

Tests whether the specified Number occurs within this range.

The exact comparison implementation varies by subclass.

public  booleancontainsRange(Range range)
    

Tests whether the specified range occurs entirely within this range.

The exact comparison implementation varies by subclass.

public  booleanequals(Object obj)
    

Compares this range to another object to test if they are equal.

.

To be equal, the class, minimum and maximum must be equal.

This implementation uses the Range.getMinimumNumber() and Range.getMaximumNumber() methods.

public  doublegetMaximumDouble()
    

Gets the maximum number in this range as a double.

This implementation uses the Range.getMaximumNumber() method.

public  floatgetMaximumFloat()
    

Gets the maximum number in this range as a float.

This implementation uses the Range.getMaximumNumber() method.

public  intgetMaximumInteger()
    

Gets the maximum number in this range as a int.

This implementation uses the Range.getMaximumNumber() method.

public  longgetMaximumLong()
    

Gets the maximum number in this range as a long.

This implementation uses the Range.getMaximumNumber() method.

abstract public  NumbergetMaximumNumber()
    
public  doublegetMinimumDouble()
    

Gets the minimum number in this range as a double.

This implementation uses the Range.getMinimumNumber() method.

public  floatgetMinimumFloat()
    

Gets the minimum number in this range as a float.

This implementation uses the Range.getMinimumNumber() method.

public  intgetMinimumInteger()
    

Gets the minimum number in this range as a int.

This implementation uses the Range.getMinimumNumber() method.

public  longgetMinimumLong()
    

Gets the minimum number in this range as a long.

This implementation uses the Range.getMinimumNumber() method.

abstract public  NumbergetMinimumNumber()
    
public  inthashCode()
    

Gets a hashCode for the range.

This implementation uses the Range.getMinimumNumber() and Range.getMaximumNumber() methods.

public  booleanoverlapsRange(Range range)
    

Tests whether the specified range overlaps with this range.

The exact comparison implementation varies by subclass.

public  StringtoString()
    

Gets the range as a String.

The format of the String is 'Range[min,max]'.

This implementation uses the Range.getMinimumNumber() and Range.getMaximumNumber() methods.



Constructor Detail
Range
public Range()(Code)

Constructs a new range.





Method Detail
containsDouble
public boolean containsDouble(Number value)(Code)

Tests whether the specified Number occurs within this range using double comparison..

null is handled and returns false.

This implementation forwards to the Range.containsDouble(double) method.


Parameters:
  value - the double to test, may be null true if the specified number occurs within thisrange by double comparison



containsDouble
public boolean containsDouble(double value)(Code)

Tests whether the specified double occurs within this range using double comparison.

This implementation uses the Range.getMinimumDouble() and Range.getMaximumDouble() methods and should be good for most uses.


Parameters:
  value - the double to test true if the specified number occurs within thisrange by double comparison



containsFloat
public boolean containsFloat(Number value)(Code)

Tests whether the specified Number occurs within this range using float comparison.

null is handled and returns false.

This implementation forwards to the Range.containsFloat(float) method.


Parameters:
  value - the float to test, may be null true if the specified number occurs within thisrange by float comparison



containsFloat
public boolean containsFloat(float value)(Code)

Tests whether the specified float occurs within this range using float comparison.

This implementation uses the Range.getMinimumFloat() and Range.getMaximumFloat() methods and should be good for most uses.


Parameters:
  value - the float to test true if the specified number occurs within thisrange by float comparison



containsInteger
public boolean containsInteger(Number value)(Code)

Tests whether the specified Number occurs within this range using int comparison..

null is handled and returns false.

This implementation forwards to the Range.containsInteger(int) method.


Parameters:
  value - the integer to test, may be null true if the specified number occurs within thisrange by int comparison



containsInteger
public boolean containsInteger(int value)(Code)

Tests whether the specified int occurs within this range using int comparison.

This implementation uses the Range.getMinimumInteger() and Range.getMaximumInteger() methods and should be good for most uses.


Parameters:
  value - the int to test true if the specified number occurs within thisrange by int comparison



containsLong
public boolean containsLong(Number value)(Code)

Tests whether the specified Number occurs within this range using long comparison..

null is handled and returns false.

This implementation forwards to the Range.containsLong(long) method.


Parameters:
  value - the long to test, may be null true if the specified number occurs within thisrange by long comparison



containsLong
public boolean containsLong(long value)(Code)

Tests whether the specified long occurs within this range using long comparison.

This implementation uses the Range.getMinimumLong() and Range.getMaximumLong() methods and should be good for most uses.


Parameters:
  value - the long to test true if the specified number occurs within thisrange by long comparison



containsNumber
abstract public boolean containsNumber(Number number)(Code)

Tests whether the specified Number occurs within this range.

The exact comparison implementation varies by subclass. It is intended that an int specific subclass will compare using int comparison.

null is handled and returns false.


Parameters:
  number - the number to test, may be null true if the specified number occurs within this range
throws:
  IllegalArgumentException - if the Number cannot be compared



containsRange
public boolean containsRange(Range range)(Code)

Tests whether the specified range occurs entirely within this range.

The exact comparison implementation varies by subclass. It is intended that an int specific subclass will compare using int comparison.

null is handled and returns false.

This implementation uses the Range.containsNumber(Number) method. Subclasses may be able to optimise this.


Parameters:
  range - the range to test, may be null true if the specified range occurs entirely withinthis range; otherwise, false
throws:
  IllegalArgumentException - if the Range cannot be compared



equals
public boolean equals(Object obj)(Code)

Compares this range to another object to test if they are equal.

.

To be equal, the class, minimum and maximum must be equal.

This implementation uses the Range.getMinimumNumber() and Range.getMaximumNumber() methods. Subclasses may be able to optimise this.


Parameters:
  obj - the reference object with which to compare true if this object is equal



getMaximumDouble
public double getMaximumDouble()(Code)

Gets the maximum number in this range as a double.

This implementation uses the Range.getMaximumNumber() method. Subclasses may be able to optimise this.

the maximum number in this range



getMaximumFloat
public float getMaximumFloat()(Code)

Gets the maximum number in this range as a float.

This implementation uses the Range.getMaximumNumber() method. Subclasses may be able to optimise this.

the maximum number in this range



getMaximumInteger
public int getMaximumInteger()(Code)

Gets the maximum number in this range as a int.

This implementation uses the Range.getMaximumNumber() method. Subclasses may be able to optimise this.

the maximum number in this range



getMaximumLong
public long getMaximumLong()(Code)

Gets the maximum number in this range as a long.

This implementation uses the Range.getMaximumNumber() method. Subclasses may be able to optimise this.

the maximum number in this range



getMaximumNumber
abstract public Number getMaximumNumber()(Code)

Gets the maximum number in this range.

the maximum number in this range



getMinimumDouble
public double getMinimumDouble()(Code)

Gets the minimum number in this range as a double.

This implementation uses the Range.getMinimumNumber() method. Subclasses may be able to optimise this.

the minimum number in this range



getMinimumFloat
public float getMinimumFloat()(Code)

Gets the minimum number in this range as a float.

This implementation uses the Range.getMinimumNumber() method. Subclasses may be able to optimise this.

the minimum number in this range



getMinimumInteger
public int getMinimumInteger()(Code)

Gets the minimum number in this range as a int.

This implementation uses the Range.getMinimumNumber() method. Subclasses may be able to optimise this.

the minimum number in this range



getMinimumLong
public long getMinimumLong()(Code)

Gets the minimum number in this range as a long.

This implementation uses the Range.getMinimumNumber() method. Subclasses may be able to optimise this.

the minimum number in this range



getMinimumNumber
abstract public Number getMinimumNumber()(Code)

Gets the minimum number in this range.

the minimum number in this range



hashCode
public int hashCode()(Code)

Gets a hashCode for the range.

This implementation uses the Range.getMinimumNumber() and Range.getMaximumNumber() methods. Subclasses may be able to optimise this.

a hash code value for this object



overlapsRange
public boolean overlapsRange(Range range)(Code)

Tests whether the specified range overlaps with this range.

The exact comparison implementation varies by subclass. It is intended that an int specific subclass will compare using int comparison.

null is handled and returns false.

This implementation uses the Range.containsNumber(Number) and Range.containsRange(Range) methods. Subclasses may be able to optimise this.


Parameters:
  range - the range to test, may be null true if the specified range overlaps with thisrange; otherwise, false
throws:
  IllegalArgumentException - if the Range cannot be compared



toString
public String toString()(Code)

Gets the range as a String.

The format of the String is 'Range[min,max]'.

This implementation uses the Range.getMinimumNumber() and Range.getMaximumNumber() methods. Subclasses may be able to optimise this.

the String representation of this range



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) 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.