class Psych::Nodes::Sequence

[edit]

要約

YAML sequence http://yaml.org/spec/1.1/#sequence/syntax を表すクラスです。

YAML sequence とは基本的にはリスト、配列です。以下のような例が考えられます。

%YAML 1.1
---
- I am
- a Sequence

YAML sequence には anchor を付加することができます。この例では Psych::Nodes::Sequence#anchor は "A" を返します。

%YAML 1.1
---
&A [
  "This sequence",
  "has an anchor"
]

tag を付けることもできます。この例では Psych::Nodes::Sequence#tag は "tag:yaml.org,2002:seq" (!seq はこの tag の別名)を返します。

%YAML 1.1
---
!!seq [
  "This sequence",
  "has a tag"
]

Psych::Nodes::Sequence は 0 個以上の子ノードを持つことができます。子ノードは以下のいずれかクラスのインスタンスでなければなりません。

目次

特異メソッド
インスタンスメソッド
定数

継承しているメソッド

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

特異メソッド

new(anchor=nil, tag=nil, implicit=true, style=BLOCK) -> Psych::Nodes::Sequence[permalink][rdoc][edit]

新たな sequence オブジェクトを生成します。

anchor には sequence に付加されている anchor を文字列で指定します。 anchor を付けない場合には nil を指定します。

tag には sequence に付加されている tag を文字列で指定します。 tag を付けない場合には nil を指定します。

implicit には sequence が implicit に開始されたかどうかを真偽値で指定します。

style には YAML ドキュメント上の style を整数で指定します。以下のいずれかを指定できます。

[PARAM] anchor:
sequence に付加された anchor
[PARAM] tag:
sequence に付加された tag
[PARAM] implicit:
sequence が implicit に開始されたかどうか
[PARAM] style:
YAML ドキュメント上の style

インスタンスメソッド

anchor -> String|nil[permalink][rdoc][edit]

sequence に付加された anchor を返します。

[SEE_ALSO] Psych::Nodes::Sequence#anchor=, Psych::Nodes::Sequence.new

anchor=(a)[permalink][rdoc][edit]

sequence に付加する anchor を設定します。

[PARAM] a:
設定する anchor

[SEE_ALSO] Psych::Nodes::Sequence#anchor, Psych::Nodes::Sequence.new

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

sequence が implicit に開始されたかどうかを真偽値で返します。

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

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

sequence が implicit に開始されたかどうかを真偽値で設定します。

[PARAM] bool:
設定値

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

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

sequence の style を返します。

[SEE_ALSO] Psych::Nodes::Sequence#style=, Psych::Nodes::Sequence.new

style=(sty)[permalink][rdoc][edit]

sequence の style を設定します。

[PARAM] sty:
設定する style

[SEE_ALSO] Psych::Nodes::Sequence#style, Psych::Nodes::Sequence.new

tag -> String|nil[permalink][rdoc][edit]

sequence に付加された tag を返します。

[SEE_ALSO] Psych::Nodes::Sequence#tag=, Psych::Nodes::Sequence.new

tag=(t)[permalink][rdoc][edit]

sequence に付加する tag を設定します。

[PARAM] t:
設定する tag

[SEE_ALSO] Psych::Nodes::Sequence#anchor=, Psych::Nodes::Sequence.new

定数

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

「任意」のスタイルを意味します。

emitter が適当に style を決めます。

[SEE_ALSO] Psych::Nodes::Sequence.new, Psych::Nodes::Sequence#style, Psych::Handler#start_sequence

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

block style を表します。

[SEE_ALSO] Psych::Nodes::Sequence.new, Psych::Nodes::Sequence#style, Psych::Handler#start_sequence

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

flow style を表します。

[SEE_ALSO] Psych::Nodes::Sequence.new, Psych::Nodes::Sequence#style