StringUtil (Nablarch-API)

java.lang.Object
- nablarch.core.util.StringUtil

```
public final class StringUtil
extends java.lang.Object
```
文字列ユーティリティクラス。
文字列に関する汎用的な処理を提供する。
本クラスのメソッドには、insert(String, String, int...)のように文字列編集用途に使用するメソッドも用意されている。これらのメソッドは、例えば、電話番号をハイフン区切りに整形する等のフォーマット処理用に使用されることを想定している。プロジェクトでフォーマット用のユーティリティを作成する場合、これらのメソッドを使用するとよい。

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static java.lang.String`	`chomp(java.lang.String target, java.lang.String end)` 行末の文字列を切り落とす。
`static byte[]`	`getBytes(java.lang.String string, java.nio.charset.Charset charset)` 指定された文字セットで文字列をエンコードする。
`static boolean`	`hasValue(java.util.Collection<java.lang.String> strings)` コレクションが何らかの文字列を含んでいるか判定する。
`static boolean`	`hasValue(java.lang.String... strings)` 文字列配列が何らかの文字列を含んでいるか判定する。
`static boolean`	`hasValue(java.lang.String string)` Stringインスタンスが何らかの文字を含んでいるか判定する。
`static java.lang.String`	`insert(java.lang.String target, java.lang.String delimiter, int... intervals)` 区切り文字を文字列先頭から挿入する。
`static java.lang.String`	`insertFromRight(java.lang.String target, java.lang.String delimiter, int... intervals)` 区切り文字を右側から挿入する。
`static java.lang.String`	`insertRepeatedly(java.lang.String target, java.lang.String delimiter, int interval)` 区切り文字を等間隔で挿入する。
`static java.lang.String`	`insertRepeatedlyFromRight(java.lang.String target, java.lang.String delimiter, int interval)` 区切り文字を右側から等間隔で挿入する。
`static boolean`	`isNullOrEmpty(java.util.Collection<java.lang.String> strings)` `null`または空文字列判定を行う。
`static boolean`	`isNullOrEmpty(java.lang.String... strings)` `null`または空文字列判定を行う。
`static boolean`	`isNullOrEmpty(java.lang.String string)` `null`または空文字列判定を行う。
`static java.lang.String`	`join(java.lang.String separator, java.util.List<java.lang.String> params)` 複数の文字列をセパレータを挟んで結合する。
`static java.lang.String`	`lowerAndTrimUnderScore(java.lang.String value)` 大文字を小文字にし、アンダースコアを削除する。
`static java.lang.String`	`lpad(java.lang.String string, int length, char padChar)` 文字列の左側に、指定された文字を指定された文字列長に到達するまで加える。
`static java.lang.String[]`	`merge(java.lang.String[]... arrays)` 文字列配列を連結する。
`static java.lang.String`	`nullToEmpty(java.lang.String value)` 引数で渡された値が`null`の場合、空文字を返却する。
`static java.lang.String`	`repeat(java.lang.Object repeated, int times)` 文字列を繰り返す。
`static java.lang.String`	`rpad(java.lang.String string, int length, char padChar)` 文字列の右側に、指定された文字を指定された文字列長に到達するまで加える。
`static java.util.List<java.lang.String>`	`split(java.lang.String str, java.lang.String separator)` 文字列をセパレータで分割する。
`static java.util.List<java.lang.String>`	`split(java.lang.String str, java.lang.String separator, boolean trim)` 文字列をセパレータで分割する。
`static java.lang.String[]`	`toArray(java.util.Collection<java.lang.String> collection)` コレクションを配列に変換する。
`static java.lang.String`	`toString(byte[] bytes, java.nio.charset.Charset charset)` 指定された文字セットでバイト配列をデコードする。
`static java.lang.String`	`toString(java.lang.Object value)` 指定された値を文字列に変換する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - lpad
```
@Published
public static java.lang.String lpad(java.lang.String string,
                                               int length,
                                               char padChar)
```
    文字列の左側に、指定された文字を指定された文字列長に到達するまで加える。
    stringの文字数 >= length の場合はstringの文字列をそのまま返却。
    例:
```
 StringUtil.lpad("100", 10, '0'); //--> "0000000100"
 
```
    パラメータ:
    
    string - 文字列(null不可)
    
    length - 変換後文字列のサイズ(0以上)
    
    padChar - 加える文字
    
    戻り値:
    
    フォーマット後文字列
  - rpad
```
@Published
public static java.lang.String rpad(java.lang.String string,
                                               int length,
                                               char padChar)
```
    文字列の右側に、指定された文字を指定された文字列長に到達するまで加える。
    stringの文字数 >= length の場合はstringの文字列をそのまま返却。
    例:
```
 StringUtil.rpad("100", 10, '0'); //--> "1000000000"
 
```
    パラメータ:
    
    string - 文字列(null不可)
    
    length - 変換後文字列のサイズ(0以上)
    
    padChar - 加える文字
    
    戻り値:
    
    フォーマット後文字列
  - isNullOrEmpty
```
@Published
public static boolean isNullOrEmpty(java.lang.String string)
```
    nullまたは空文字列判定を行う。
```
 |引数                | 戻り値
 +--------------------+--------
 | null               | true
 | ""                 | true
 | "hoge"             | false
 | " " (半角スペース) | false
 | "　"(全角スペース) | false
 
```
    パラメータ:
    
    string - 文字列
    
    戻り値:
    
    nullまたは空文字列の場合はtrue
  - isNullOrEmpty
```
@Published
public static boolean isNullOrEmpty(java.lang.String... strings)
```
    nullまたは空文字列判定を行う。
    与えられた文字列配列内の要素全てがnullまたは空文字であればtrueを返却する。
```
 |引数                | 戻り値
 +--------------------+--------
 | null               | true
 | {}                 | true
 | {"", null}         | true
 | { null, "a" }      | false
 | " " (半角スペース) | false
 | "　"(全角スペース) | false
 
```
    パラメータ:
    
    strings - 文字列配列
    
    戻り値:
    
    全要素がnullまたは空文字の時、true
    
    関連項目:
    
    isNullOrEmpty(String)
  - isNullOrEmpty
```
@Published
public static boolean isNullOrEmpty(java.util.Collection<java.lang.String> strings)
```
    nullまたは空文字列判定を行う。
    与えられたコレクション内の要素全てがnullまたは空文字であればtrueを返却する。
```
 |引数                | 戻り値
 +--------------------+--------
 | null               | true
 | {}                 | true
 | {"", null}         | true
 | { null, "a" }      | false
 | " " (半角スペース) | false
 | "　"(全角スペース) | false
 
```
    パラメータ:
    
    strings - 文字列を格納したコレクション
    
    戻り値:
    
    全要素がnullまたは空文字の時、true
    
    関連項目:
    
    isNullOrEmpty(String)
  - hasValue
```
@Published
public static boolean hasValue(java.lang.String string)
```
    Stringインスタンスが何らかの文字を含んでいるか判定する。
    isNullOrEmpty(String)と逆の真偽値を返却する。否定演算子を使用することで可読性が劣る場合は本メソッドを使用すると良い。
    例を以下に示す。
```
 private String something;

 public void hasSomething() {
     return (!StringUtil.isNullOrEmpty(this.something)) {
 }
 
```
    以下のように書き換えることで、単純に読み下すことができる。 public void hasSomething() { return StringUtil.hasValue(this.something); }
    パラメータ:
    
    string - 文字列
    
    戻り値:
    
    なんらかの文字が含まれている場合はtrue
    
    関連項目:
    
    isNullOrEmpty(String)
  - hasValue
```
@Published
public static boolean hasValue(java.lang.String... strings)
```
    文字列配列が何らかの文字列を含んでいるか判定する。
    isNullOrEmpty(String...)と逆の真偽値を返却する。否定演算子を使用することで可読性が劣る場合は本メソッドを使用すると良い。
    
    パラメータ:
    
    strings - 調査対象となる文字列配列
    
    戻り値:
    
    何らかの文字列を含む場合、true
    
    関連項目:
    
    isNullOrEmpty(String...), hasValue(String)
  - hasValue
```
@Published
public static boolean hasValue(java.util.Collection<java.lang.String> strings)
```
    コレクションが何らかの文字列を含んでいるか判定する。
    isNullOrEmpty(Collection)と逆の真偽値を返却する。否定演算子を使用することで可読性が劣る場合は本メソッドを使用すると良い。
    
    パラメータ:
    
    strings - 調査対象となるコレクション
    
    戻り値:
    
    何らかの文字列を含む場合、true
    
    関連項目:
    
    isNullOrEmpty(String...), hasValue(String)
  - toString
```
public static java.lang.String toString(byte[] bytes,
                                        java.nio.charset.Charset charset)
```
    指定された文字セットでバイト配列をデコードする。
    JDK1.6以上を使用する場合は、java.lang.String(byte[], Charset)を使用すること。
    bytesがnullだった場合、nullを返す。
    
    パラメータ:
    
    bytes - バイト配列
    
    charset - 文字セット
    
    戻り値:
    
    文字列
  - toString
```
public static java.lang.String toString(java.lang.Object value)
```
    指定された値を文字列に変換する。
    指定された値がBigDecimalの場合には、 BigDecimal.toPlainString()を使用して文字列に変換する。それ以外のオブジェクトの場合には、toString()により文字列化を行う。
    
    パラメータ:
    
    value - 文字列に変換する値
    
    戻り値:
    
    文字列に変換した値
  - getBytes
```
@Published(tag="architect")
public static byte[] getBytes(java.lang.String string,
                                                          java.nio.charset.Charset charset)
```
    指定された文字セットで文字列をエンコードする。
    JDK1.6以上を使用する場合は、java.lang.String#getBytes(Charset)を使用すること。
    stringがnullだった場合、nullを返す。 stringが空文字だった場合、空のバイト配列を返す。
    
    パラメータ:
    
    string - 文字列
    
    charset - 文字セット
    
    戻り値:
    
    バイト配列
  - repeat
```
@Published(tag="architect")
public static java.lang.String repeat(java.lang.Object repeated,
                                                                  int times)
```
    文字列を繰り返す。
    引数が文字列でない場合は、String.valueOf(Object)された文字列が繰り返される。
    
    パラメータ:
    
    repeated - 繰り返し文字列(null不可)
    
    times - 繰り返し回数(0以上)
    
    戻り値:
    
    文字列
  - insert
```
@Published(tag="architect")
public static java.lang.String insert(java.lang.String target,
                                                                  java.lang.String delimiter,
                                                                  int... intervals)
```
    区切り文字を文字列先頭から挿入する。
    例:
```
 StringUtil.insert("あいうえお", ",", 1, 1, 1); //-->あ,い,う,えお
 
```
    パラメータ:
    
    target - 対象文字列(null不可)
    
    delimiter - 区切り文字(null不可)
    
    intervals - 挿入間隔(null不可・0不可)
    
    戻り値:
    
    区切り文字挿入後の文字列
  - insertFromRight
```
@Published(tag="architect")
public static java.lang.String insertFromRight(java.lang.String target,
                                                                           java.lang.String delimiter,
                                                                           int... intervals)
```
    区切り文字を右側から挿入する。
    例:
```
 StringUtil.insertFromRight("あいうえお", ",", 1, 1, 1); //-->あい,う,え,お
 
```
    パラメータ:
    
    target - 対象文字列(null不可)
    
    delimiter - 区切り文字(null不可)
    
    intervals - 文字列後ろからの挿入間隔(null不可・0不可)
    
    戻り値:
    
    区切り文字挿入後の文字列
  - insertRepeatedly
```
@Published(tag="architect")
public static java.lang.String insertRepeatedly(java.lang.String target,
                                                                            java.lang.String delimiter,
                                                                            int interval)
```
    区切り文字を等間隔で挿入する。
    例:
```
 StringUtil.insertRepeatedly("あいうえお", ",", 1) //-->あ,い,う,え,お
 
```
    パラメータ:
    
    target - 対象文字列(null不可)
    
    delimiter - 区切り文字(null不可)
    
    interval - 間隔(0不可)
    
    戻り値:
    
    区切り文字挿入後の文字列
  - insertRepeatedlyFromRight
```
@Published(tag="architect")
public static java.lang.String insertRepeatedlyFromRight(java.lang.String target,
                                                                                     java.lang.String delimiter,
                                                                                     int interval)
```
    区切り文字を右側から等間隔で挿入する。
    例：
```
 StringUtil.insertRepeatedlyFromRight("あいうえお", ",", 1) //-->あ,い,う,え,お
 
```
    パラメータ:
    
    target - 対象文字列
    
    delimiter - 区切り文字
    
    interval - 間隔(0不可)
    
    戻り値:
    
    区切り文字挿入後の文字列
  - chomp
```
@Published
public static java.lang.String chomp(java.lang.String target,
                                                java.lang.String end)
```
    行末の文字列を切り落とす。
    
    パラメータ:
    
    target - 文字列(null不可)
    
    end - 取り除く文字列(null不可)
    
    戻り値:
    
    行末を取り除いた文字列
    
    例外:
    
    {@link - IllegalArgumentException} 引数がnullの場合
  - merge
```
public static java.lang.String[] merge(java.lang.String[]... arrays)
```
    文字列配列を連結する。
    
    パラメータ:
    
    arrays - 配列(null不可)
    
    戻り値:
    
    連結後の配列
    
    例外:
    
    {@link - IllegalArgumentException} 配列がnullの場合
  - toArray
```
public static java.lang.String[] toArray(java.util.Collection<java.lang.String> collection)
```
    コレクションを配列に変換する。
    
    パラメータ:
    
    collection - 変換対象のコレクション(null不可)
    
    戻り値:
    
    変換後の配列
    
    例外:
    
    {@link - IllegalArgumentException} 変換対象のコレクションがnullの場合
  - lowerAndTrimUnderScore
```
public static java.lang.String lowerAndTrimUnderScore(java.lang.String value)
```
    大文字を小文字にし、アンダースコアを削除する。
    
    パラメータ:
    
    value - 変換対象の文字列(null不可)
    
    戻り値:
    
    変換後の文字列
  - nullToEmpty
```
@Published
public static java.lang.String nullToEmpty(java.lang.String value)
```
    引数で渡された値がnullの場合、空文字を返却する。
    そうでない場合は、引数をそのまま返却する。
```
 
 StringUtil.nullToEmpty(null);   //--> ""
 StringUtil.nullToEmpty("");     //--> ""
 StringUtil.nullToEmpty("hoge"); //--> "hoge"
 
 
```
    パラメータ:
    
    value - 変換対象の値
    
    戻り値:
    
    変換後の値
  - join
```
@Published
public static java.lang.String join(java.lang.String separator,
                                               java.util.List<java.lang.String> params)
```
    複数の文字列をセパレータを挟んで結合する。
    
    パラメータ:
    
    separator - セパレータ
    
    params - 結合する文字列
    
    戻り値:
    
    セパレータで結合した文字列
  - split
```
@Published
public static java.util.List<java.lang.String> split(java.lang.String str,
                                                                java.lang.String separator)
```
    文字列をセパレータで分割する。
    
    パラメータ:
    
    str - 分割対象文字列
    
    separator - セパレータ
    
    戻り値:
    
    分割された文字列
  - split
```
@Published
public static java.util.List<java.lang.String> split(java.lang.String str,
                                                                java.lang.String separator,
                                                                boolean trim)
```
    文字列をセパレータで分割する。
    
    パラメータ:
    
    str - 文字列
    
    separator - セパレータ
    
    trim - 分割後の文字列をトリムする場合、true
    
    戻り値:
    
    分割された文字列

クラス StringUtil

メソッドのサマリー

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

メソッドの詳細

lpad

rpad

isNullOrEmpty

isNullOrEmpty

isNullOrEmpty

hasValue

hasValue

hasValue

toString

toString

getBytes

repeat

insert

insertFromRight

insertRepeatedly

insertRepeatedlyFromRight

chomp

merge

toArray

lowerAndTrimUnderScore

nullToEmpty

join

split

split