ConsoleScanner

java.lang.Object
- xyz.hotchpotch.util.console.ConsoleScanner<T>

型パラメータ:

T - 最終的にクライアント・アプリケーションに返却されるデータの型

すべての実装されたインタフェース:

java.util.function.Supplier<T>
```
public class ConsoleScanner<T>
extends java.lang.Object
implements java.util.function.Supplier<T>
```
標準入力から対話的にユーザ入力を取得するためのクラスです。

求める形式とは異なる入力をユーザが行った場合、ConsoleScanner はユーザに何度も再入力を求めます。
正しい形式の入力が得られたら、それを必要な形式（数値、クラス、列挙型等）に変換し、クライアント・アプリケーションに返却します。

次の例では、0～12の範囲の整数を標準入力から対話的に取得します。
```
     int n = ConsoleScanner.intBuilder(0, 12).build().get();
 
```
次の例では、列挙型 MyEnum の要素の中のひとつを選択するようユーザに要求し、選択された要素を取得します。
```
     MyEnum selected = ConsoleScanner.enumBuilder(MyEnum.class).build().get();
 
```
このほか、正規表現を指定して入力を求めることなども可能です。
標準出力に表示するプロンプトや、要求とは異なる形式の入力をユーザが行った場合に表示するエラーメッセージをカスタマイズすることができます。
詳細は各メソッドの説明を参照してください。

このクラスのオブジェクトはスレッドセーフではありません。
このクラスのオブジェクトを複数のスレッドで共有しないでください。

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

static class ConsoleScanner.Builder<T>
ConsoleScanner オブジェクトを構築するためのビルダーです。

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`ConsoleScanner.Builder<T>` `ConsoleScanner` オブジェクトを構築するためのビルダーです。

メソッドのサマリー

All Methods Static Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`static <T> ConsoleScanner.Builder<T>`	`builder(java.util.function.Predicate<java.lang.String> judge, java.util.function.Function<java.lang.String,T> converter, java.lang.String prompt, java.lang.String complaint)` 任意の型の入力を取得するための `ConsoleScanner` のビルダーを返します。
`static <E extends java.lang.Enum<E>> ConsoleScanner.Builder<E>`	`enumBuilder(java.lang.Class<E> type)` 列挙型の要素の中から選択された要素を取得するための `ConsoleScanner` のビルダーを返します。
`T`	`get()` 標準入力から対話的にユーザ入力値を取得し、目的の型に変換して返します。
`static ConsoleScanner.Builder<java.lang.Integer>`	`intBuilder(int lower, int upper)` `Integer` 型の入力を取得するための `ConsoleScanner` のビルダーを返します。
`static <T> ConsoleScanner.Builder<T>`	`listBuilder(java.util.List<T> list)` リストの中から選択された要素を取得するための `ConsoleScanner` のビルダーを返します。
`static ConsoleScanner.Builder<java.lang.Long>`	`longBuilder(long lower, long upper)` `Long` 型の入力を取得するための `ConsoleScanner` のビルダーを返します。
`static ConsoleScanner.Builder<java.lang.String>`	`stringBuilder(java.util.regex.Pattern pattern)` `String` 型の入力を取得するための `ConsoleScanner` のビルダーを返します。
`static ConsoleScanner.Builder<java.lang.String>`	`stringBuilder(java.util.function.Predicate<java.lang.String> judge)` `String` 型の入力を取得するための `ConsoleScanner` のビルダーを返します。
`static ConsoleScanner.Builder<java.lang.String>`	`stringBuilder(java.lang.String regex)` `String` 型の入力を取得するための `ConsoleScanner` のビルダーを返します。
`static ConsoleScanner<java.lang.String>`	`waiter()` ユーザが確認するまで待機するための `ConsoleScanner` を生成します。
`static ConsoleScanner<java.lang.String>`	`waiter(java.lang.String prompt)` ユーザが確認するまで待機するための `ConsoleScanner` を生成します。

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

- メソッドの詳細
  - stringBuilder
```
public static ConsoleScanner.Builder<java.lang.String> stringBuilder(java.util.function.Predicate<java.lang.String> judge)
```
    String 型の入力を取得するための ConsoleScanner のビルダーを返します。
    
    パラメータ:
    
    judge - ユーザ入力値が要求形式に合致するかを判定する Predicate
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.NullPointerException - judge が null の場合
  - stringBuilder
```
public static ConsoleScanner.Builder<java.lang.String> stringBuilder(java.util.regex.Pattern pattern)
```
    String 型の入力を取得するための ConsoleScanner のビルダーを返します。
    
    パラメータ:
    
    pattern - ユーザ入力値が要求形式に合致するかを判定する Pattern
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.NullPointerException - pattern が null の場合
  - stringBuilder
```
public static ConsoleScanner.Builder<java.lang.String> stringBuilder(java.lang.String regex)
```
    String 型の入力を取得するための ConsoleScanner のビルダーを返します。
    
    パラメータ:
    
    regex - ユーザ入力値が要求形式に合致するかを判定する正規表現文字列
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.NullPointerException - regex が null の場合
    
    java.util.regex.PatternSyntaxException - regex を Pattern にコンパイルできない場合
    
    関連項目:
    
    Pattern.compile(String)
  - intBuilder
```
public static ConsoleScanner.Builder<java.lang.Integer> intBuilder(int lower,
                                                                   int upper)
```
    Integer 型の入力を取得するための ConsoleScanner のビルダーを返します。
    
    パラメータ:
    
    lower - 要求する範囲の下限値（この値を範囲に含みます）
    
    upper - 要求する範囲の上限値（この値を範囲に含みます）
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.IllegalArgumentException - upper よりも lower が大きい場合
  - longBuilder
```
public static ConsoleScanner.Builder<java.lang.Long> longBuilder(long lower,
                                                                 long upper)
```
    Long 型の入力を取得するための ConsoleScanner のビルダーを返します。
    
    パラメータ:
    
    lower - 要求する範囲の下限値（この値を範囲に含みます）
    
    upper - 要求する範囲の上限値（この値を範囲に含みます）
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.IllegalArgumentException - upper よりも lower が大きい場合
  - listBuilder
```
public static <T> ConsoleScanner.Builder<T> listBuilder(java.util.List<T> list)
```
    リストの中から選択された要素を取得するための ConsoleScanner のビルダーを返します。
    
    型パラメータ:
    
    T - 最終的にクライアント・アプリケーションに返却されるデータの型
    
    パラメータ:
    
    list - 選択対象の要素が格納されたリスト
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.NullPointerException - list が null の場合
    
    java.lang.IllegalArgumentException - list の要素数が 0 の場合
  - enumBuilder
```
public static <E extends java.lang.Enum<E>> ConsoleScanner.Builder<E> enumBuilder(java.lang.Class<E> type)
```
    列挙型の要素の中から選択された要素を取得するための ConsoleScanner のビルダーを返します。
    
    型パラメータ:
    
    E - 最終的にクライアント・アプリケーションに返却されるデータの型
    
    パラメータ:
    
    type - 列挙型クラス
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.NullPointerException - type が null の場合
  - builder
```
public static <T> ConsoleScanner.Builder<T> builder(java.util.function.Predicate<java.lang.String> judge,
                                                    java.util.function.Function<java.lang.String,T> converter,
                                                    java.lang.String prompt,
                                                    java.lang.String complaint)
```
    任意の型の入力を取得するための ConsoleScanner のビルダーを返します。
    
    型パラメータ:
    
    T - 最終的にクライアント・アプリケーションに返却されるデータの型
    
    パラメータ:
    
    judge - ユーザ入力値が要求形式に合致するかを判定する Predicate
    
    converter - ユーザ入力文字列を T 型に変換するための Function
    
    prompt - 標準出力に表示するプロンプト文字列
    
    complaint - ユーザが要求とは異なる形式で入力した場合に標準出力に表示するエラー文字列
    
    戻り値:
    
    ConsoleScanner.Builder オブジェクト
    
    例外:
    
    java.lang.NullPointerException - judge、converter、prompt、complaint のいずれかが null の場合
  - waiter
```
public static ConsoleScanner<java.lang.String> waiter()
```
    ユーザが確認するまで待機するための ConsoleScanner を生成します。
    生成される ConsoleScanner の get() メソッドは、標準出力に「何か入力すると続行します > 」と表示し、ユーザが何らかの入力を行うとその入力値を返します。
    
    戻り値:
    
    ユーザが確認するまで待機するための ConsoleScanner
  - waiter
```
public static ConsoleScanner<java.lang.String> waiter(java.lang.String prompt)
```
    ユーザが確認するまで待機するための ConsoleScanner を生成します。
    生成される ConsoleScanner の get() メソッドは、標準出力にプロンプト文字列を表示し、ユーザが何らかの入力を行うとその入力値を返します。
    
    パラメータ:
    
    prompt - 標準出力に表示するプロンプト文字列
    
    戻り値:
    
    ユーザが確認するまで待機するための ConsoleScanner
    
    例外:
    
    java.lang.NullPointerException - prompt が null の場合
  - get
```
public T get()
```
    標準入力から対話的にユーザ入力値を取得し、目的の型に変換して返します。
    要求する形式の入力値が得られるまで、ユーザに何度も再入力を求めます。
    
    定義:
    
    get インタフェース内 java.util.function.Supplier<T>
    
    戻り値:
    
    ユーザ入力値を変換した T 型の値

クラス ConsoleScanner<T>

ネストされたクラスのサマリー

メソッドのサマリー

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

メソッドの詳細

stringBuilder

stringBuilder

stringBuilder

intBuilder

longBuilder

listBuilder

enumBuilder

builder

waiter

waiter

get