org.apache.commons.lang
クラス NumberUtils

java.lang.Object
  org.apache.commons.lang.NumberUtils

public final class NumberUtils

extends Object

Java Number クラスに対する付加機能を提供します。

Provides extra functionality for Java Number classes.

バージョン:

$Id: NumberUtils.java,v 1.1.1.1 2004/02/13 10:02:04 hioki Exp $

作成者:

Henri Yandell, Rand McNeely, Stephen Colebourne, Steve Downey

翻訳者:

日置 聡

翻訳状況:

初稿(校正者募集中)

翻訳更新日:

2003/08/13

コンストラクタの概要

NumberUtils()
NumberUtils のインスタンスは一般的なプログラムからは生成すべきではありません。

メソッドの概要

static int	compare(double lhs, double rhs) 2つの double の大きさを比べます。
static int	compare(float lhs, float rhs) 2つの float の大きさを比べます。
static BigDecimal	createBigDecimal(String val) String を BigDecimal に変換します。
static BigInteger	createBigInteger(String val) String を BigInteger に変換します。
static Double	createDouble(String val) String を Double に変換します。
static Float	createFloat(String val) String を Float に変換します。
static Integer	createInteger(String val) 16進数、8進数の記号をハンドリングして String を Integer に変換します。
static Long	createLong(String val) String を Long に変換します。
static Number	createNumber(String val) 文字列の値を java.lang.Number に変換します。
private static boolean	isAllZeros(String s) createNumber のためのユーティリティメソッド。
static boolean	isDigits(String str) String が数字の文字だけで構成されているかをチェックします。
static boolean	isNumber(String str) String が有効な Java の数値を示しているかをチェックします。
static int	maximum(int a, int b, int c) 3つの中で一番大きな int の値を取得します。
static long	maximum(long a, long b, long c) 3つの中で一番大きな long の値を取得します。
static int	minimum(int a, int b, int c) 3つの中で一番小さい int の値を取得します。
static long	minimum(long a, long b, long c) 3つの中で一番小さい long の値を取得します。
static int	stringToInt(String str) String を int に変換します。
static int	stringToInt(String str, int defaultValue) String を int に変換します。

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

NumberUtils

public NumberUtils()

NumberUtils のインスタンスは一般的なプログラムからは生成すべきではありません。 代わりに NumberUtils.stringToInt("6"); というように使用すべきです。 このコンストラクタは、処理に JavaBean インスタンスを必要とするツールのために public になっています。

NumberUtils instances should NOT be constructed in standard programming. Instead, the class should be used as NumberUtils.stringToInt("6");. This constructor is public to permit tools that require a JavaBean instance to operate.

メソッドの詳細

stringToInt

public static int stringToInt(String str)

String を int に変換します。変換に失敗した場合には 0 を返します。

Convert a String to an int, returning zero if the conversion fails

パラメータ:

str - 変換する文字列

the string to convert

戻り値:

文字列が示す int の値、変換に失敗した場合には 0

the int represented by the string, or zero if conversion fails

stringToInt

public static int stringToInt(String str,
                              int defaultValue)

String を int に変換します。変換に失敗した場合にはデフォルトの値を返します。

Convert a String to an int, returning a default value if the conversion fails.

パラメータ:

str - 変換する文字列

the string to convert

defaultValue - デフォルトの値

the default value

戻り値:

文字列が示す int の値、変換に失敗した場合にはデフォルトの値

the int represented by the string, or the default if conversion fails

createNumber

public static Number createNumber(String val)
                           throws NumberFormatException

文字列の値を java.lang.Number に変換します。 まず最初に文字列の末尾の修飾('f','F','d','D','l','L')を調べます。 これが見つかった場合、指定された型に該当する型を保持する値が小さいものから順に試行し生成します。

Turns a string value into a java.lang.Number. First, the value is examined for a type qualifier on the end ('f','F','d','D','l','L'). If it is found, it starts trying to create succissively larger types from the type specified until one is found that can hold the value.

型を定義する記述が見つからなかった場合には、小数点がなかった場合には Integer から BigInteger まで、あった場合には Float から BigDecimal までを順に 試行し生成します。

If a type specifier is not found, it will check for a decimal point and then try successively larger types from Integer to BigInteger and from Float to BigDecimal.

文字列が "0x" または "-0x" で始まる場合には16進数とみなされます。 0 で始まる値は8進数とはみなされません。

If the string starts with "0x" or "-0x", it will be interpreted as a hexadecimal integer. Values with leading 0's will not be interpreted as octal.

パラメータ:

val - 数値を含んだ文字列

String containing a number

戻り値:

文字列から生成された Number

Number created from the string

例外:

NumberFormatException - 変換が行えなかった場合

if the value cannot be converted

isAllZeros

private static boolean isAllZeros(String s)

createNumber のためのユーティリティメソッド。s が null だった場合に true を返します。

Utility method for createNumber. Returns true if s is null

パラメータ:

s - 評価対象となる String

the String to check

戻り値:

null または全て0だった場合

if it is all zeros or null

createFloat

public static Float createFloat(String val)

String を Float に変換します。

Convert a String to a Float

パラメータ:

val - 変換の対象となる String

a String to convert

戻り値:

変換された Float

converted Float

例外:

NumberFormatException - 変換が行えなかった場合

if the value cannot be converted

createDouble

public static Double createDouble(String val)

String を Double に変換します。

Convert a String to a Double

パラメータ:

val - 変換の対象となる String

a String to convert

戻り値:

変換された Double

converted Double

例外:

NumberFormatException - 変換が行えなかった場合

if the value cannot be converted

createInteger

public static Integer createInteger(String val)

16進数、8進数の記号をハンドリングして String を Integer に変換します。

Convert a String to a Integer, handling hex and octal notations.

パラメータ:

val - 変換の対象となる String

a String to convert

戻り値:

変換された Integer

converted Integer

例外:

NumberFormatException - 変換が行えなかった場合

if the value cannot be converted

createLong

public static Long createLong(String val)

String を Long に変換します。

Convert a String to a Long

パラメータ:

val - 変換の対象となる String

a String to convert

戻り値:

変換された Long

converted Long

例外:

NumberFormatException - 変換が行えなかった場合

if the value cannot be converted

createBigInteger

public static BigInteger createBigInteger(String val)

String を BigInteger に変換します。

Convert a String to a BigInteger

パラメータ:

val - 変換の対象となる String

a String to convert

戻り値:

変換された BigInteger

converted BigInteger

例外:

NumberFormatException - 変換が行えなかった場合

if the value cannot be converted

createBigDecimal

public static BigDecimal createBigDecimal(String val)

String を BigDecimal に変換します。

Convert a String to a BigDecimal

パラメータ:

val - 変換の対象となる String

a String to convert

戻り値:

変換された BigDecimal

converted BigDecimal

例外:

NumberFormatException - 変換が行えなかった場合

if the value cannot be converted

minimum

public static long minimum(long a,
                           long b,
                           long c)

3つの中で一番小さい long の値を取得します。

Gets the minimum of three long values.

パラメータ:

a - 値1

value 1

b - 値2

value 2

c - 値3

value 3

戻り値:

一番小さな値

the largest of the values

minimum

public static int minimum(int a,
                          int b,
                          int c)

3つの中で一番小さい int の値を取得します。

Gets the minimum of three int values.

パラメータ:

a - 値1

value 1

b - 値2

value 2

c - 値3

value 3

戻り値:

一番小さな値

the largest of the values

maximum

public static long maximum(long a,
                           long b,
                           long c)

3つの中で一番大きな long の値を取得します。

Gets the maximum of three long values.

パラメータ:

a - 値1

value 1

b - 値2

value 2

c - 値3

value 3

戻り値:

一番大きな値

the largest of the values

maximum

public static int maximum(int a,
                          int b,
                          int c)

3つの中で一番大きな int の値を取得します。

Gets the maximum of three int values.

パラメータ:

a - 値1

value 1

b - 値2

value 2

c - 値3

value 3

戻り値:

一番大きな値

the largest of the values

compare

public static int compare(double lhs,
                          double rhs)

2つの double の大きさを比べます。

Compares two doubles for order.

このメソッドは標準的なJavaの比較演算よりも包括的です。 最初の値が2つ目の値よりも小さい場合 -1 を返します。 最初の値が2つ目の値よりも大きい場合 +1 を返します。 両方の値が等しい場合 0 を返します。

This method is more comprhensive than the standard Java greater than, less than and equals operators. It returns -1 if the first value is less than the second. It returns +1 if the first value is greater than the second. It returns 0 if the values are equal.

評価される順番は大きい順に以下のようになります:

• NaN
• 正の無限大
• double の最大値
• 正の数値
• +0.0
• -0.0
• 負の数値
• double の最小値(-Double.MAX_VALUE)
• 負の無限大

NaN と NaN の比較は 0 を返します。

The ordering is as follows, largest to smallest:

• NaN
• Positive infinity
• Maximum double
• Normal positve numbers
• +0.0
• -0.0
• Normal negative numbers
• Minimum double (-Double.MAX_VALUE)
• Negative infinity

Comparing NaN with NaN will return 0.

パラメータ:

lhs - 最初の double

the first double

rhs - 次の double

the second double

戻り値:

lhsの方が小さい場合 -1、lhsの方が大きい場合 +1、等しい場合 0

-1 if lhs is less, +1 if greater, 0 if equal to rhs

compare

public static int compare(float lhs,
                          float rhs)

2つの float の大きさを比べます。

Compares two floats for order.

このメソッドは標準的なJavaの比較演算よりも包括的です。 最初の値が2つ目の値よりも小さい場合 -1 を返します。 最初の値が2つ目の値よりも大きい場合 +1 を返します。 両方の値が等しい場合 0 を返します。

This method is more comprhensive than the standard Java greater than, less than and equals operators. It returns -1 if the first value is less than the second. It returns +1 if the first value is greater than the second. It returns 0 if the values are equal.

評価される順番は大きい順に以下のようになります:

• NaN
• 正の無限大
• float の最大値
• 正の数値
• +0.0
• -0.0
• 負の数値
• float の最小値(-Float.MAX_VALUE)
• 負の無限大

NaN と NaN の比較は 0 を返します。

The ordering is as follows, largest to smallest:

• NaN
• Positive infinity
• Maximum float
• Normal positve numbers
• +0.0
• -0.0
• Normal negative numbers
• Minimum float (-Float.MAX_VALUE)
• Negative infinity

Comparing NaN with NaN will return 0.

パラメータ:

lhs - 最初の float

the first float

rhs - 次の float

the second float

戻り値:

lhsの方が小さい場合 -1、lhsの方が大きい場合 +1、等しい場合 0

-1 if lhs is less, +1 if greater, 0 if equal to rhs

isDigits

public static boolean isDigits(String str)

String が数字の文字だけで構成されているかをチェックします。 null 、空の文字列が指定された場合には false を返します。

Checks whether the String contains only digit characters. Null and blank string will return false.

パラメータ:

str - 評価対象となる文字列

the string to check

戻り値:

数字の文字だけで構成されているかどうか

boolean contains only unicode numeric

isNumber

public static boolean isNumber(String str)

String が有効な Java の数値を示しているかをチェックします。 有効な数値には "0x" の修飾のある16進数、数値を表す際に使用される記号、 型を定義する符号(例 123L)が含まれます。

Checks whether the String a valid Java number. Valid numbers include hexadecimal marked with the "0x" qualifier, scientific notation and numbers marked with a type qualifier (e.g. 123L).

null 、空の文字列が指定された場合には false を返します。

Null and blank string will return false.

パラメータ:

str - 評価対象となる文字列

the string to check

戻り値:

文字列が正しい数値のフォーマットだった場合 true

true if the string is a correctly formatted number