class Psych::Nodes::Document

要約

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

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

• Psych::Nodes::Sequence
• Psych::Nodes::Mapping
• Psych::Nodes::Scalar

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

目次

特異メソッド

• new

インスタンスメソッド

• implicit
• implicit=
• implicit_end
• implicit_end=
• root
• tag_directives
• tag_directives=
• version
• version=

継承しているメソッド

Psych::Nodes::Nodeから継承しているメソッド

• children
• each
• tag
• to_ruby
• to_yaml
• transform
• yaml

Enumerableから継承しているメソッド

• all?
• any?
• chain
• chunk
• chunk_while
• collect
• collect_concat
• compact
• count
• cycle
• detect
• drop
• drop_while
• each_cons
• each_entry
• each_slice
• each_with_index
• each_with_object
• entries
• filter
• filter_map
• find
• find_all
• find_index
• first
• flat_map
• grep
• grep_v
• group_by
• include?
• inject
• lazy
• map
• max
• max_by
• member?
• min
• min_by
• minmax
• minmax_by
• none?
• one?
• partition
• reduce
• reject
• reverse_each
• select
• slice_after
• slice_before
• slice_when
• sort
• sort_by
• sum
• take
• take_while
• tally
• to_a
• to_h
• uniq
• zip

特異メソッド

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

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][edit]

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

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

implicit=(bool)[permalink][rdoc][edit]

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

[PARAM] bool:

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

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

implicit_end -> bool[permalink][rdoc][edit]

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

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

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

implicit_end=(bool)[permalink][rdoc][edit]

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

[PARAM] bool:

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

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

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

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

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

tag directive の配列を返します。

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

tag_directives=(tags)[permalink][rdoc][edit]

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

[PARAM] tags:

設定する tag directive の配列

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

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

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

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

version=(ver)[permalink][rdoc][edit]

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

[PARAM] ver:

設定するバージョン

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