hiJSON.Engine (OtsuLibrary)

java.lang.Object
- otsu.hiNote.hiJSON.Engine

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

Cloneable

含まれているクラス:

hiJSON
```
public static class hiJSON.Engine
extends Object
implements Cloneable
```
型割り当てエンジン.
hiJSONのstaticメソッドと同じ名称のメソッドとasClass()メソッドを持ちます。

hiJSONメソッドは連結式となっています。
入口はhiJSONのstaticメソッドでこのメソッドは本クラスのインスタンスを返します。その後連結されるメソッドは本クラスで行っています。
```
   String _json_text="...";
   //
   hiJSON.parseText(_json_text)              // 新たなEngineを返す
         .with_option(hiU.CHECK_UNSET_FIELD) // Engineの機能
         .asClass(Sample.class)              // Engineの機能
   //
   hiJSON.with_option(hiU.CHECK_UNSET_FIELD) // 新たなEngineを返す
         .parseText(_json_text)              // Engineの機能
         .asClass(Sample.class)              // Engineの機能
```
本クラスのメソッドの多くはエンジンの状態を変更するものですが、hiJSON.parseXX()で新たなEngineを返しますので、asXXXで結果を得た後に影響は残りません。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`hiJSON.Engine`	`accept_fields(Class<?> class_, String... fieldNames_)` 特定フィールドのパーズを可能とする. hiU.PUBLIC_ONLY指定時にpublic以外のメンバを許します。
`<T> T`	`as(Class<T> class_)` 指定の型にパーズする
`<TT> TT`	`as(hiJSON.TX<TT> tobj_)` 指定の型にパーズする
`<T> T`	`asClass(Class<T> class_)` 指定の型にパーズする
`<TT> TT`	`asClass(hiJSON.TX<TT> tobj_)` 指定の型にパーズする
`<T> ArrayList<T>`	`asClassList(Class<T> class_)` 指定型を内容とするリストを得る.
`<T> LinkedHashMap<String,T>`	`asClassValues(Class<T> class_)` リスト{...}形式ではない名前付き値並びから指定クラスの辞書を得る.
`Map<String,Object>`	`asMap()` 構造解析のみ行いMapを得る.
`<T> T`	`asMap(Class<T> class_)` Map(String,Object)を引数とする利用者nodeクラスを構築する.
`ArrayList<Map<String,Object>>`	`asMapList()` 要素の並びをパーズし、Mapのリストを得る.
`Object`	`asNode()` 構造解析のみ行う.
`<T> T`	`asNode(Class<T> class_)` node(Object)を引数として利用者nodeクラスを構築する.
`ArrayList<Object>`	`asNodeList()` 要素の並びをパーズし、Objectのリストを得る.
`LinkedHashMap<String,Object>`	`asNodeValues()` リスト{...}形式ではない名前付き値並から汎用Objectの辞書を得る.
`hiJSON.Probe`	`asProbe()` 構造解析のみ行いProbeを得る.
`hiJSON.Engine`	`clone()`
`hiJSON.Engine`	`parse(String json_text_)` パーズするテキストを指定.
`hiJSON.Engine`	`parseFile(String fileName_)` パーズ対象の読み込み元ファイルを指定する.
`hiJSON.Engine`	`parseNode(Object json_obj_)` パーズする構造オブジェクトを指定.
`hiJSON.Engine`	`parseReader(Reader json_reader_)` パーズ対象の読み込み元を指定する.
`hiJSON.Engine`	`parseText(String json_text_)` パーズするテキストを指定.
`hiFieldFormat`	`str_format()` この機構の表示フォーマットを得る.
`void`	`str_reset_format()` このエンジンの表示フォーマットをリセットする.
`String`	`str(Object obj_)` JSON表示
`String`	`str(Object obj_, long option_)` JSON表示
`<T> void`	`toMember(Object target_obj_, String member_name_)` 指定のインスタンスのメンバにパーズする
`<T> void`	`toStaticMember(Class<T> class_, String member_name_)` 指定の型のstaticメンバにデータを得る
`String`	`toString()` 概要表示(間違って表示したときの用心).
`hiJSON.Engine`	`with_atType_parse(hiU.QuadrFunctionEx<Class<?>,hiField,String,Object,Object,Exception> check_func_)` @typeパーズ手続き設定.
`hiJSON.Engine`	`with_class_from_node(Class<?> class_, hiU.TriFunctionEx<Class<?>,hiField,Object,Object,Exception> check_func_)` nodeをクラスに割り当てる処理設定.
`hiJSON.Engine`	`with_dict_parse(String key_, hiU.TriFunctionEx<String,Object,Map<String,Object>,Object,Exception> check_func_)` 辞書形式解析.
`hiJSON.Engine`	`with_functionStyle_parse(String funcName_, hiU.BiFunctionEx<String,ArrayList<Object>,Object,Exception> check_func_)` 関数形式配列解析手続き設定.
`hiJSON.Engine`	`with_option(long option_)` パーズオプションを指定する.
`hiJSON.Engine`	`with_regex_node_parse(hiU.BiFunctionEx<String,String,Object,Exception> func_)` 正規表現形式解析手続き設定.
`hiJSON.Engine`	`without_option(long option_)` パーズオプションを無効にする.

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

- メソッドの詳細
  - clone
```
public hiJSON.Engine clone()
```
    オーバーライド:
    
    clone クラス内 Object
  - toString
```
public String toString()
```
    概要表示(間違って表示したときの用心). 含んでいるソース種別または内容をhiJSON.Engine{...}の形で表示します。
    
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:
    
    文字列
  - str_format
```
public hiFieldFormat str_format()
```
    この機構の表示フォーマットを得る.
    変更はエンジンに反映されます。
    
    戻り値:
    
    フォーマッタ
  - str_reset_format
```
public void str_reset_format()
```
    このエンジンの表示フォーマットをリセットする.
  - str
```
public String str(Object obj_)
```
    JSON表示
    
    パラメータ:
    
    obj_ - オブジェクト
    
    戻り値:
    
    文字列
  - str
```
public String str(Object obj_,
                  long option_)
```
    JSON表示
    
    パラメータ:
    
    obj_ - オブジェクト
    
    option_ - オプション
    
    戻り値:
    
    文字列
  - with_functionStyle_parse
```
public hiJSON.Engine with_functionStyle_parse(String funcName_,
                                              hiU.BiFunctionEx<String,ArrayList<Object>,Object,Exception> check_func_)
```
    関数形式配列解析手続き設定.
    関数形式の記述 func(aaa,bbb)の処理をラムダ式で指定します。
    
    ラムダ式は次の形です。
```
 Object func(String 関数名,ArrayList<Object> 括弧内の要素並び)
```
    パラメータ:
    
    funcName_ - 関数名
    
    check_func_ - ラムダ式
    
    戻り値:
    
    パーズ・エンジン
  - with_regex_node_parse
```
public hiJSON.Engine with_regex_node_parse(hiU.BiFunctionEx<String,String,Object,Exception> func_)
```
    正規表現形式解析手続き設定.
    正規表現形式記述 /rrrrr/p の処理をラムダ式で指定します。
    pはオプションで省略できます。
    
    ラムダ式は次の形です。
```
  Object func(String 正規表現,String オプション)
```
    パラメータ:
    
    func_ - ラムダ式
    
    戻り値:
    
    this
  - with_dict_parse
```
public hiJSON.Engine with_dict_parse(String key_,
                                     hiU.TriFunctionEx<String,Object,Map<String,Object>,Object,Exception> check_func_)
```
    辞書形式解析.
    指定要素を持つ辞書の置き換えをラムダ式で指定
    
    ラムダ式は次の形です。
```
 Object func(String 指定された要素名,String 指定された要素の値
            ,Map<String,Object> 指定された要素も含む辞書)
```
    パラメータ:
    
    key_ - 辞書のキー
    
    check_func_ - ラムダ式
    
    戻り値:
    
    パーズ・エンジン
  - accept_fields
```
public hiJSON.Engine accept_fields(Class<?> class_,
                                   String... fieldNames_)
```
    特定フィールドのパーズを可能とする. hiU.PUBLIC_ONLY指定時にpublic以外のメンバを許します。
    hiJSON.accept_fields(Class,String...)参照
    
    パラメータ:
    
    class_ - クラス
    
    fieldNames_ - フィールド名
    
    戻り値:
    
    パーズ・エンジン
  - with_class_from_node
```
public hiJSON.Engine with_class_from_node(Class<?> class_,
                                          hiU.TriFunctionEx<Class<?>,hiField,Object,Object,Exception> check_func_)
```
    nodeをクラスに割り当てる処理設定.
    nodeパーズ時に特定の型のjson汎用オブジェクトを部分パーズするラムダ式を登録します。
    
    ラムダ式は次の形です。
```
 Object func(Class クラス,hiField フィールド情報（フィールド名等がある）,
             Object nodeオブジェクト)
```
    hiJSON.with_class_from_node(Class,otsu.hiNote.hiU.TriFunctionEx)参照
    パラメータ:
    
    class_ - チェックするクラス
    
    check_func_ - ラムダ式
    
    戻り値:
    
    パーズ・エンジン
  - with_atType_parse
```
public hiJSON.Engine with_atType_parse(hiU.QuadrFunctionEx<Class<?>,hiField,String,Object,Object,Exception> check_func_)
```
    @typeパーズ手続き設定.
    @typeフィールドを持つクラスで@type情報による自動割り当てができなかったものに対して呼ばれる
    hiJSON.with_atType_parse(otsu.hiNote.hiU.QuadrFunctionEx)参照
    
    パラメータ:
    
    check_func_ - ラムダ式
    
    戻り値:
    
    バーズ・エンジン
  - parseText
```
public hiJSON.Engine parseText(String json_text_)
```
    パーズするテキストを指定. hiJSON.parseText(String)参照
    
    パラメータ:
    
    json_text_ - パーズする文字列
    
    戻り値:
    
    パーズ・エンジン
  - parse
```
public final hiJSON.Engine parse(String json_text_)
```
    パーズするテキストを指定. hiJSON.parseText(String)参照
    
    パラメータ:
    
    json_text_ - パーズする文字列
    
    戻り値:
    
    パーズ・エンジン
  - parseNode
```
public hiJSON.Engine parseNode(Object json_obj_)
```
    パーズする構造オブジェクトを指定.
    
    パラメータ:
    
    json_obj_ - JSON構造オブジェクト
    
    戻り値:
    
    パーズ・エンジン
  - parseReader
```
public final hiJSON.Engine parseReader(Reader json_reader_)
```
    パーズ対象の読み込み元を指定する.
    
    パラメータ:
    
    json_reader_ - Reader
    
    戻り値:
    
    パーズ・エンジン
  - parseFile
```
public final hiJSON.Engine parseFile(String fileName_)
```
    パーズ対象の読み込み元ファイルを指定する.
    
    パラメータ:
    
    fileName_ - ファイル名
    
    戻り値:
    
    パーズ・エンジン
  - with_option
```
public final hiJSON.Engine with_option(long option_)
```
    パーズオプションを指定する. hiJSON.with_option(long)参照
    
    パラメータ:
    
    option_ - オプション
    
    戻り値:
    
    パーズ・エンジン
  - without_option
```
public final hiJSON.Engine without_option(long option_)
```
    パーズオプションを無効にする.
    
    パラメータ:
    
    option_ - オプション
    
    戻り値:
    
    パーズ・エンジン
  - asClass
```
public <T> T asClass(Class<T> class_)
```
    指定の型にパーズする
    
    型パラメータ:
    
    T - 型
    
    パラメータ:
    
    class_ - 型
    
    戻り値:
    
    パーズ結果
  - as
```
public <T> T as(Class<T> class_)
```
    指定の型にパーズする
    
    型パラメータ:
    
    T - 型
    
    パラメータ:
    
    class_ - 型
    
    戻り値:
    
    パーズ結果
  - toStaticMember
```
public <T> void toStaticMember(Class<T> class_,
                               String member_name_)
```
    指定の型のstaticメンバにデータを得る
    
    型パラメータ:
    
    T - 型
    
    パラメータ:
    
    class_ - 型
    
    member_name_ - メンバ名
  - toMember
```
public <T> void toMember(Object target_obj_,
                         String member_name_)
```
    指定のインスタンスのメンバにパーズする
    
    型パラメータ:
    
    T - 型
    
    パラメータ:
    
    target_obj_ - このインスタンスのメンバにデータを得る
    
    member_name_ - メンバ名
  - asClass
```
public <TT> TT asClass(hiJSON.TX<TT> tobj_)
```
    指定の型にパーズする
    
    型パラメータ:
    
    TT - 型
    
    パラメータ:
    
    tobj_ - 指定型情報を持つTX型のインスタンス
    
    戻り値:
    
    パーズ結果
  - as
```
public <TT> TT as(hiJSON.TX<TT> tobj_)
```
    指定の型にパーズする
    
    型パラメータ:
    
    TT - 型
    
    パラメータ:
    
    tobj_ - 指定型情報を持つTX型のインスタンス
    
    戻り値:
    
    パーズ結果
  - asClassList
```
public <T> ArrayList<T> asClassList(Class<T> class_)
```
    指定型を内容とするリストを得る.
    []で囲まれた配列をパーズし指定型のArrayListを得ます。
```
[
   {id:'001',name:'田中',age:51},
   {id:'002',name:'鈴木',age:32},
   {id:'003',name:'山田',age:63},
   {id:'004',name:'佐藤',age:40}
   ]
```
    次のように、[]で囲まれない、名前付きの値の並びのパーズも可能です
```
{id:'001',name:'田中',age:51}
{id:'002',name:'鈴木',age:32}
{id:'003',name:'山田',age:63}
{id:'004',name:'佐藤',age:40}
```
    型パラメータ:
    
    T - 型
    
    パラメータ:
    
    class_ - 内容となる型
    
    戻り値:
    
    指定型を内容とするArrayList
  - asNodeList
```
public ArrayList<Object> asNodeList()
```
    要素の並びをパーズし、Objectのリストを得る.
    要素並びをパーズし、汎用Objectのリストを得ます。
```
[
   {id:'001',name:'田中',age:51},
   {id:'002',name:'鈴木',age:32},
   {id:'003',name:'山田',age:63},
   {id:'004',name:'佐藤',age:40}
   ]
```
    []で囲まれない、形式も受け付けます。
```
{id:'001',name:'田中',age:51}
{id:'002',name:'鈴木',age:32}
{id:'003',name:'山田',age:63}
{id:'004',name:'佐藤',age:40}
```
    戻り値:
    
    Nodeのリスト
  - asMapList
```
public ArrayList<Map<String,Object>> asMapList()
```
    要素の並びをパーズし、Mapのリストを得る.
    要素並びをパーズしMap<String,Object>のリストを得ます。
    
    戻り値:
    
    Nodeのリスト
  - asClassValues
```
public <T> LinkedHashMap<String,T> asClassValues(Class<T> class_)
```
    リスト{...}形式ではない名前付き値並びから指定クラスの辞書を得る.
    次のように、{}で囲まれない、名前付きの値の並びをパーズします。
```
u1={id:'001',name:'田中',age:51}
u2={id:'002',name:'鈴木',age:32}
u3={id:'003',name:'山田',age:63}
u4={id:'004',name:'佐藤',age:40}
```
    型パラメータ:
    
    T - 型
    
    パラメータ:
    
    class_ - 内容となる型
    
    戻り値:
    
    LinkedHashMap
  - asNodeValues
```
public LinkedHashMap<String,Object> asNodeValues()
```
    リスト{...}形式ではない名前付き値並から汎用Objectの辞書を得る.
    次のように、{}で囲まれない、名前付きの値の並びをパーズします。
```
u1={id:'001',name:'田中',age:51}
u2={id:'002',name:'鈴木',age:32}
u3={id:'003',name:'山田',age:63}
u4={id:'004',name:'佐藤',age:40}
```
    戻り値:
    
    LinkedHashMap
  - asNode
```
public Object asNode()
```
    構造解析のみ行う.
    parseNode(xxx).asNode()を流れではxxxがそのまま返ります。
    
    戻り値:
    
    構造オブジェクト
  - asProbe
```
public hiJSON.Probe asProbe()
```
    構造解析のみ行いProbeを得る.
    
    戻り値:
    
    Probe
  - asNode
```
public <T> T asNode(Class<T> class_)
```
    node(Object)を引数として利用者nodeクラスを構築する.
    ノードツリーObjectを利用者クラスの構築子に与えます。
    
    型パラメータ:
    
    T - 利用者クラス
    
    パラメータ:
    
    class_ - 利用者クラス
    
    戻り値:
    
    構造オブジェクト
  - asMap
```
public Map<String,Object> asMap()
```
    構造解析のみ行いMapを得る.
    
    戻り値:
    
    構造オブジェクト
  - asMap
```
public <T> T asMap(Class<T> class_)
```
    Map(String,Object)を引数とする利用者nodeクラスを構築する.
    ノードツリーObjectをMapにキャストした上で利用者クラスの構築子に与えます。
    
    型パラメータ:
    
    T - 利用者クラス
    
    パラメータ:
    
    class_ - 利用者クラス
    
    戻り値:
    
    構造オブジェクト

クラス hiJSON.Engine

メソッドのサマリー

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

メソッドの詳細

clone

toString

str_format

str_reset_format

str

str

with_functionStyle_parse

with_regex_node_parse

with_dict_parse

accept_fields

with_class_from_node

with_atType_parse

parseText

parse

parseNode

parseReader

parseFile

with_option

without_option

asClass

as

toStaticMember

toMember

asClass

as

asClassList

asNodeList

asMapList

asClassValues

asNodeValues

asNode

asProbe

asNode

asMap

asMap