Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > psychライブラリ > Psych::Nodes::Documentクラス

class Psych::Nodes::Document

クラスの継承リスト: Psych::Nodes::Document < Psych::Nodes::Node < Enumerable < Object < Kernel < BasicObject

要約

YAML ドキュメントを表すクラスです。

このノードは Psych::Nodes::Stream の子ノードでなければ なりません。このノードは1個の子ノードを持たなければなりません。 またこの子ノードは以下のいずれかである必要があります。

この唯一の子ノードは「ルート」とも呼ばれ、Psych::Nodes::Document#root で アクセスすることができます。

目次

特異メソッド
new
インスタンスメソッド
implicit implicit= implicit_end implicit_end= root tag_directives tag_directives= version version=

特異メソッド

new(version=[], tag_directives=[], implicit=false) -> Psych::Nodes::Document[permalink][rdoc]

Document オブジェクトを生成します。

version にはドキュメントのバージョンを指定します。 [major, minor] という配列で指定します。

tag_directives には tag directive の配列を指定します。 それぞれの tag は [prefix, suffix] という文字列の配列で 表現します。

implicit にはドキュメントが implicit に始まっているかどうかを 真偽値で指定します。

[PARAM] version:
YAML ドキュメントのバージョン
[PARAM] tag_directives:
tag directive の配列
[PARAM] implicit:
ドキュメントが implicit に始まっているかどうか

以下の例では、YAML 1.1 のドキュメントで、 tag directive を1つ持ち、 implicit にドキュメントが開始 している Document オブジェクトを生成しています。

Psych::Nodes::Document.new(
  [1,1],
  [["!", "tag:tenderlovemaking.com,2009:"]],
  true)

[SEE_ALSO] Psych::Handler#start_document

インスタンスメソッド

implicit -> bool[permalink][rdoc]

ドキュメントが implicit に始まっているかどうかを返します。

[SEE_ALSO] Psych::Nodes::Document#implicit=, Psych::Nodes::Document.new

implicit=(bool)[permalink][rdoc]

ドキュメントが implicit に始まっているかどうかを設定します。

[PARAM] bool:
ドキュメントが implicit に始まっているかどうかの設定値

[SEE_ALSO] Psych::Nodes::Document#implicit, Psych::Nodes::Document.new

implicit_end -> bool[permalink][rdoc]

ドキュメントが implicit に終わっているかどうかを返します。

オブジェクト生成時のデフォルト値は true です。

[SEE_ALSO] Psych::Nodes::Document#implicit_end=

implicit_end=(bool)[permalink][rdoc]

ドキュメントが implicit に終わっているかどうかを設定します。

[PARAM] bool:
ドキュメントが implicit に終わっているかどうかの設定値

[SEE_ALSO] Psych::Nodes::Document#implicit_end

root -> Psych::Nodes::Node[permalink][rdoc]

ルートノードを返します。

tag_directives -> [[String, String]][permalink][rdoc]

tag directive の配列を返します。

[SEE_ALSO] Psych::Nodes::Document#tag_directives=, Psych::Nodes::Document.new

tag_directives=(tags)[permalink][rdoc]

tag directive の配列を設定します。

[PARAM] tags:
設定する tag directive の配列

[SEE_ALSO] Psych::Nodes::Document#tag_directives, Psych::Nodes::Document.new

version -> [Integer][permalink][rdoc]

YAML ドキュメントのバージョンを返します。

[SEE_ALSO] Psych::Nodes::Document#version=, Psych::Nodes::Document.new

version=(ver)[permalink][rdoc]

YAML ドキュメントのバージョンを設定します。

[PARAM] ver:
設定するバージョン

[SEE_ALSO] Psych::Nodes::Document#version, Psych::Nodes::Document.new