検索結果

REXML::Child#document -> REXML::Document | nil (73369.0)

• 3.2

• インスタンスメソッド

そのノードが属する document (REXML::Document) を返します。

そのノードが属する document (REXML::Document) を返します。

属する document が存在しない場合は nil を返します。

• REXML::Child
• REXML::Document

REXML::Element#document -> REXML::Document | nil (73303.0)

• 3.2

• インスタンスメソッド

self が属する文書(REXML::Document)オブジェクトを返します。

self が属する文書(REXML::Document)オブジェクトを返します。

属する文書がない場合には nil を返します。

• REXML::Document
• REXML::Element

RDoc::RDoc#document(argv) -> nil (72604.0)

• 3.2

• インスタンスメソッド

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ
レクトリに出力します。

@param argv コマンドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。

@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。

• RDoc::RDoc

Psych::Handler#start_document(version, tag_directives, implicit) -> () (36640.0)

• 3.2

• インスタンスメソッド

YAML ドキュメントの始まりで呼び出されます。

YAML ドキュメントの始まりで呼び出されます。

version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。

tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。

implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。

必要に応じてこのメソッドを override してください。


@param version ...

• Psych::Handler

RDoc::CodeObject#document_children -> bool (36622.0)

• 3.2

• インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。

@see RDoc::CodeObject#document_self

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#document_children=(val) (36622.0)

• 3.2

• インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、上記をドキュメントに含めます。

@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules

• RDoc::CodeObject

RDoc::CodeObject#document_self -> bool (36622.0)

• 3.2

• インスタンスメソッド

自身をドキュメントに含めるかどうかを返します。

自身をドキュメントに含めるかどうかを返します。

@see RDoc::CodeObject#document_children

• RDoc::CodeObject

RDoc::CodeObject#document_self=(val) (36622.0)

• 3.2

• インスタンスメソッド

自身をドキュメントに含めるかどうかを設定します。

自身をドキュメントに含めるかどうかを設定します。

:doc: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、自身をドキュメントに含めます。

@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc

• RDoc::CodeObject

Psych::Handler#end_document(implicit) -> () (36604.0)

• 3.2

• インスタンスメソッド

ドキュメントが終了したときに呼び出されます。

ドキュメントが終了したときに呼び出されます。

ドキュメントが implicit に終わったならば implicit には真が渡されます。

必要に応じてこのメソッドを override してください。

@param implicit ドキュメントが implicit に終わったかどうか

=== 例

以下の YAML ドキュメントでは implicit は true です。
---
hello world

また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
...

• Psych::Handler

REXML::SAX2Listener#end_document -> () (36604.0)

• 3.2

• インスタンスメソッド

ドキュメントの末尾で呼び出されるコールバックメソッドです。

ドキュメントの末尾で呼び出されるコールバックメソッドです。

• REXML::SAX2Listener

絞り込み条件を変える

REXML::SAX2Listener#start_document -> () (36604.0)

• 3.2

• インスタンスメソッド

ドキュメントの先頭で呼び出されるコールバックメソッドです。

ドキュメントの先頭で呼び出されるコールバックメソッドです。

• REXML::SAX2Listener

RDoc::CodeObject#documented? -> bool (36601.0)

• 3.2

• インスタンスメソッド

出力すべきドキュメントがあるかどうかを返します。

出力すべきドキュメントがあるかどうかを返します。

• RDoc::CodeObject

static int here_document(NODE *here) (36601.0)

• 3.2

• 関数

lex_strterm 形式の term に従ってヒアドキュメントを 終端行まで読み込む。

lex_strterm 形式の term に従ってヒアドキュメントを
終端行まで読み込む。

Psych::Nodes::Document (36109.0)

• 3.2

• クラス

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

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

このノードは Psych::Nodes::Stream の子ノードでなければ
なりません。このノードは1個の子ノードを持たなければなりません。
またこの子ノードは以下のいずれかである必要があります。
* Psych::Nodes::Sequence
* Psych::Nodes::Mapping
* Psych::Nodes::Scalar
この唯一の子ノードは「ルート」とも呼ばれ、Psych::Nodes::Document#root で
アクセスすることができます。

• Psych::Nodes::Document#root
• Psych::Nodes::Mapping
• Psych::Nodes::Scalar
• Psych::Nodes::Sequence
• Psych::Nodes::Stream

REXML::Document (36055.0)

• 3.2

• クラス

XMLの完全な文書(ドキュメント)を表すクラス。

XMLの完全な文書(ドキュメント)を表すクラス。

XML処理命令(Processing Instruction, PI)、
DTD(文書型定義、Document Type Definition)、
などを含んでいます。
ドキュメントは直下の子ノードをただ一つ持っています(rootと呼び、
REXML::Document#root でアクセスできます)。
2つ目の要素を(REXML::Element#add_elementなどで)追加しようとすると
例外(RuntimeError)が発生します。

• RuntimeError

絞り込み条件を変える

rexml/document (36055.0)

• 3.2

• ライブラリ

DOM スタイルの XML パーサ。

DOM スタイルの XML パーサ。

REXML::Document.new で XML 文書から DOM ツリーを
構築し、ツリーのノードの各メソッドで文書の内容にアクセスします。

以下のプログラムではブックマークの XML からデータを取り出します。

//emlist[][ruby]{
require 'rexml/document'
require 'pp'

Bookmark = Struct.new(:href, :title, :desc)

doc = REXML::Document.new(<<XML)
<?xml version="1.0" encoding="UTF-...

• REXML::AttlistDecl
• REXML::Attribute
• REXML::Attributes
• REXML::CData
• REXML::Child
• REXML::Comment
• REXML::Declaration
• REXML::DocType
• REXML::Document
• REXML::Element
• REXML::ElementDecl
• REXML::Elements
• REXML::Encoding
• REXML::Entity
• REXML::EntityConst
• REXML::ExternalEntity
• REXML::Formatters::Default
• REXML::Formatters::Pretty
• REXML::Formatters::Transitive
• REXML::Functions
• ...

Gem::DocumentError (36001.0)

• 3.2

• クラス

システムに RDoc がインストールされていない場合に使用する例外です。

システムに RDoc がインストールされていない場合に使用する例外です。

REXML::Document#clone -> REXML::Document (27622.0)

• 3.2

• インスタンスメソッド

self を複製します。

self を複製します。

REXML::Document.new(self) と同じです。

• REXML::Document

REXML::Document#doctype -> REXML::DocType | nil (27601.0)

• 3.2

• インスタンスメソッド

文書の DTD を返します。

文書の DTD を返します。

文書が DTD を持たない場合は nil を返します。

• REXML::Document

REXML::Document#xml_decl -> REXML::XMLDecl | nil (27601.0)

• 3.2

• インスタンスメソッド

文書の XML 宣言を返します。

文書の XML 宣言を返します。

文書が XML 宣言を持たない場合は nil を返します。

• REXML::Document

絞り込み条件を変える

REXML::Document::DECLARATION -> REXML::XMLDecl (27601.0)

• 3.2

• 定数

この定数は deprecated です。REXML::XMLDecl.default を 代わりに使ってください。

この定数は deprecated です。REXML::XMLDecl.default を
代わりに使ってください。

デフォルトとして使えるXML宣言オブジェクト。

• REXML::Document

Psych::Nodes::Document#implicit -> bool (27337.0)

• 3.2

• インスタンスメソッド

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

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

@see Psych::Nodes::Document#implicit=,
Psych::Nodes::Document.new

• Psych::Nodes::Document

Psych::Nodes::Document#implicit=(bool) (27337.0)

• 3.2

• インスタンスメソッド

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

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

@param bool ドキュメントが implicit に始まっているかどうかの設定値
@see Psych::Nodes::Document#implicit,
Psych::Nodes::Document.new

• Psych::Nodes::Document

Psych::Nodes::Document#tag_directives -> [[String, String]] (27337.0)

• 3.2

• インスタンスメソッド

tag directive の配列を返します。

tag directive の配列を返します。

@see Psych::Nodes::Document#tag_directives=,
Psych::Nodes::Document.new

• Psych::Nodes::Document

Psych::Nodes::Document#tag_directives=(tags) (27337.0)

• 3.2

• インスタンスメソッド

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

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

@param tags 設定する tag directive の配列
@see Psych::Nodes::Document#tag_directives,
Psych::Nodes::Document.new

• Psych::Nodes::Document

絞り込み条件を変える

REXML::Document#encoding -> String (27337.0)

• 3.2

• インスタンスメソッド

XML 宣言に含まれている XML 文書のエンコーディングを返します。

XML 宣言に含まれている XML 文書のエンコーディングを返します。

文書が XML 宣言を持たない場合はデフォルトの値
(REXML::XMLDecl.defaultで宣言されているもの)を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<e />
EOS
doc.encoding # => "UTF-8"
//}

• REXML::Document

Psych::Nodes::Document#implicit_end -> bool (27319.0)

• 3.2

• インスタンスメソッド

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

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

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

@see Psych::Nodes::Document#implicit_end=

• Psych::Nodes::Document

Psych::Nodes::Document#implicit_end=(bool) (27319.0)

• 3.2

• インスタンスメソッド

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

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

@param bool ドキュメントが implicit に終わっているかどうかの設定値
@see Psych::Nodes::Document#implicit_end

• Psych::Nodes::Document

REXML::Document.new(source = nil, context = {}) -> REXML::Document (18796.0)

• 3.2

• 特異メソッド

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

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

source には String、IO、REXML::Document のいずかが
指定できます。 REXML::Document を指定すると
コンテキストと要素、属性が複製されます。
文字列の場合はそれを XML と見なしてパースします。
IOの場合は、XML文書を読み出してパースします。

context で「コンテキスト」を指定します。テキストノードの空白や
特殊文字の取り扱いを Hash で指定します。
以下の Symbol をハッシュのキーとして使います。

: :respect_whitespace
空白を考慮して欲しい要素の名...

• Hash
• IO
• REXML::Document
• String
• Symbol

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

• 3.2

• 特異メソッド

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

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

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

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

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

@param version YAML ドキュメントのバージョン
@param tag_directives tag directive の配列...

• Psych::Nodes::Document

絞り込み条件を変える

REXML::Text#doctype -> REXML::DocType | nil (18673.0)

• 3.2

• インスタンスメソッド

テキストノードが属する文書の DTD を返します。

テキストノードが属する文書の DTD を返します。

そのような文書(REXML::Document)が存在しない、すなわち
テキストノードの親ノードを辿っても REXML::Document に到達しない、
場合には nil を返します。

@see REXML::DocType

• REXML::DocType
• REXML::Document
• REXML::Text

REXML::Element#delete_namespace(namespace = "xmlns") -> self (18637.0)

• 3.2

• インスタンスメソッド

名前空間を要素から削除します。

名前空間を要素から削除します。

削除可能な名前空間はそのノードで宣言されているもののみです。
上位の要素で宣言されているものは削除できません。

引数を省略した場合はデフォルトの名前空間を削除します。

@param namespace 削除する名前空間の prefix

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new "<a xmlns:foo='bar' xmlns='twiddle'/>"
doc.root.delete_namespace
doc.to_s # => "<a xmlns:foo=...

• REXML::Element

RDoc::DOT_DOC_FILENAME -> ".document" (18604.0)

• 3.2

• 定数

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。

• RDoc

REXML::Elements#each(xpath = nil) {|element| ... } -> [REXML::Elements] (18481.0)

• 3.2

• インスタンスメソッド

全ての子要素に対しブロックを呼び出します。

全ての子要素に対しブロックを呼び出します。

xpath を指定した場合には、その XPath 文字列に
マッチする要素に対しブロックを呼び出します。

REXML::XPath.each などとは異なり、要素以外の
テキストノードなどはすべて無視されることに注意してください。

@param xpath XPath文字列

//emlist[][ruby]{
require 'rexml/document'
require 'rexml/xpath'
doc = REXML::Document.new '<a><b/><c/><d/>sean<b/><c/><d/></a>'
# <b/>,...

• REXML::Elements

REXML::Element#each_element_with_text(text = nil, max = 0, name = nil) {|element| ... } -> () (18409.0)

• 3.2

• インスタンスメソッド

テキストを子ノードとして 持つすべての子要素を引数としてブロックを呼び出します。

テキストを子ノードとして
持つすべての子要素を引数としてブロックを呼び出します。

text を指定すると、テキストの内容が text であるもののみを対象とします。
maxを指定すると、対象となる子要素の先頭 max 個のみが対象となります。
name を指定すると、それは xpath 文字列と見なされ、
それにマッチするもののみが対象となります。

max に 0 を指定すると、max の指定は無視されます(0個ではありません)。

@param text テキストの中身(文字列)
@param max ブロック呼出の対象とする子要素の最大個数
@param name xpath文字列

...

• REXML::Element

絞り込み条件を変える

REXML::DocType#public -> String | nil (18391.0)

• 3.2

• インスタンスメソッド

DTD の公開識別子を返します。

DTD の公開識別子を返します。

DTD が公開識別子による外部サブセットを含んでいない場合は nil を返します。

//emlist[][ruby]{
require 'rexml/document'
doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
EOS
doctype.system # => "http:/...

• REXML::DocType

REXML::XPath.each(element, path = nil, namespaces = {}, variables = {}) {|e| ... } -> () (18391.0)

• 3.2

• 特異メソッド

element の path で指定した XPath 文字列にマッチする各ノード に対してブロックを呼び出します。

element の path で指定した XPath 文字列にマッチする各ノード
に対してブロックを呼び出します。

path に相対パスを指定した場合は element からの相対位置で
マッチするノードを探します。
絶対パスを指定した場合は element が属する文書のルート要素からの
位置でマッチするノードを探します。
path を省略すると "*" を指定したことになります。

namespace で名前空間の対応付けを Hash で指定します。

variable で XPath 内の変数に対応する値を指定できます。
XPathインジェクション攻撃を避けるため、適切な
エスケープを...

• Hash
• REXML::Element
• REXML::XPath

REXML::XPath.match(element, path = nil, namespaces = {}, variables = {}) -> [Node] (18391.0)

• 3.2

• 特異メソッド

element の path で指定した XPath 文字列にマッチするノードの配列を 返します。

element の path で指定した XPath 文字列にマッチするノードの配列を
返します。

path に相対パスを指定した場合は element からの相対位置で
マッチするノードを探します。
絶対パスを指定した場合は element が属する文書のルート要素からの
位置でマッチするノードを探します。
path を省略すると "*" を指定したことになります。

namespace で名前空間の対応付けを Hash で指定します。

variable で XPath 内の変数に対応する値を指定できます。
XPathインジェクション攻撃を避けるため、適切な
エスケープを付加するため、に...

• Hash
• REXML::Element
• REXML::XPath

REXML::Element#each_element_with_attribute(key, value = nil, max = 0, name = nil) {|element| ... } -> () (18373.0)

• 3.2

• インスタンスメソッド

特定の属性を持つすべての子要素を引数としてブロックを呼び出します。

特定の属性を持つすべての子要素を引数としてブロックを呼び出します。

key で指定した属性名の属性を持つ要素のみを対象とします。
value を指定すると、keyで指定した属性名を持つ属性の値がvalueである
もののみを対象とします。
maxを指定すると、対象となる子要素の先頭 max 個のみが対象となります。
name を指定すると、それは xpath 文字列と見なされ、
それにマッチするもののみが対象となります。

max に 0 を指定すると、max の指定は無視されます(0個ではありません)。

@param key 属性名(文字列)
@param value 属性値(文字列)
...

• REXML::Element

Kernel#psych_y(*objects) -> nil (18367.0)

• 3.2

• インスタンスメソッド

objects を YAML document として標準出力に出力します。

objects を YAML document として標準出力に出力します。

このメソッドは irb 上でのみ定義されます。

syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてください。

@param objects YAML document に変換する Ruby のオブジェクト

• Kernel
• syck

絞り込み条件を変える

REXML::Attributes#each_attribute {|attribute| ... } -> () (18355.0)

• 3.2

• インスタンスメソッド

各属性に対しブロックを呼び出します。

各属性に対しブロックを呼び出します。

個々の属性は REXML::Attribute オブジェクトで渡されます。

//emlist[][ruby]{
require 'rexml/document'

doc = REXML::Document.new(<<EOS)
<root xmlns:foo="http://example.org/foo"
xmlns:bar="http://example.org/bar">
<a foo:att='1' bar:att='2' att='&lt;'/>
</root>
EOS
a = doc.get_elements("/root...

• REXML::Attribute
• REXML::Attributes

REXML::Attributes#namespaces -> { String => String } (18355.0)

• 3.2

• インスタンスメソッド

self の中で宣言されている名前空間の集合を返します。

self の中で宣言されている名前空間の集合を返します。

返り値は名前空間の prefix をキーとし、URI を値とする
Hash を返します。

//emlist[][ruby]{
require 'rexml/document'

doc = REXML::Document.new(<<EOS)
<root xmlns:foo="http://example.org/foo"
xmlns:bar="http://example.org/bar">
<a foo:att='1' bar:att='2' att='&lt;'/>
</root>
EOS
a = doc.ge...

• Hash
• REXML::Attributes

REXML::Element#namespace(prefix=nil) -> String (18355.0)

• 3.2

• インスタンスメソッド

self の文脈で prefix が指している名前空間の URI を返します。

self の文脈で prefix が指している名前空間の URI を返します。

prefix を省略すると、デフォルトの名前空間の URI を返します。

prefix で指示される名前空間の宣言が存在しない場合は nil を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new("<a xmlns='1' xmlns:y='2'><b/><c xmlns:z='3'/><y:d /></a>")
b = doc.elements['//b']
b.namespace # => "1"
...

• REXML::Element

REXML::Element#namespaces -> {String => String} (18355.0)

• 3.2

• インスタンスメソッド

self の文脈で定義されている名前空間の情報を返します。

self の文脈で定義されている名前空間の情報を返します。

対象の要素とその外側の要素で定義されている名前空間を、{ prefix => 識別子 }
というハッシュテーブルで返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new("<a xmlns:x='1' xmlns:y='2'><b/><c xmlns:z='3'/></a>")
doc.elements['//b'].namespaces # => {"x"=>"1", "y"=>"2"}
//}

• REXML::Element

Object#psych_to_yaml(options = {}) -> String (18349.0)

• 3.2

• インスタンスメソッド

オブジェクトを YAML document に変換します。

オブジェクトを YAML document に変換します。

options でオプションを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。

syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予定であるため、特別の事情がない限り to_yaml を用いてください。

@param options 出力オプション
@see Psych.dump

• Object
• syck

絞り込み条件を変える

RDoc::CodeObject#remove_classes_and_modules -> () (18349.0)

• 3.2

• インスタンスメソッド

何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。

何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。

• RDoc::CodeObject

RDoc::CodeObject#remove_methods_etc -> () (18349.0)

• 3.2

• インスタンスメソッド

何もしません。RDoc::CodeObject#document_self= に false を指定した 時のコールバックとして呼び出されます。オーバーライドして使用します。

何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。

• RDoc::CodeObject

RDoc::CodeObject#start_doc -> () (18337.0)

• 3.2

• インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。

@see RDoc::CodeObject#end_doc

• RDoc::CodeObject

RDoc::CodeObject#stop_doc -> () (18337.0)

• 3.2

• インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま での間、ドキュメントに含めません。

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。

:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。

@see RDoc::CodeObject#start_doc

• RDoc::CodeObject

REXML::Attributes#each {|name, value| ... } -> () (18337.0)

• 3.2

• インスタンスメソッド

各属性の名前と値に対しブロックを呼び出します。

各属性の名前と値に対しブロックを呼び出します。

名前には expanded_name(REXML::Namespace#exapnded_name)が
渡されます。

//emlist[][ruby]{
require 'rexml/document'

doc = REXML::Document.new(<<EOS)
<root xmlns:foo="http://example.org/foo"
xmlns:bar="http://example.org/bar">
<a foo:att='1' bar:att='2' att='&lt;'/>
</root>
EOS
a...

• REXML::Attributes

絞り込み条件を変える

REXML::DocType#context -> { Symbol => object } (18337.0)

• 3.2

• インスタンスメソッド

DTD が属する文書の「コンテキスト」を返します。

DTD が属する文書の「コンテキスト」を返します。

具体的には親ノードである REXML::Document オブジェクトの
REXML::Element#context を返します。

コンテキストの具体的な内容については REXML::Element#context を
参照してください。

• REXML::DocType
• REXML::Document

REXML::Document#<<(child) -> () (18337.0)

• 3.2

• インスタンスメソッド

子ノードを追加します。

子ノードを追加します。

追加できるものは
* XML宣言(REXML::XMLDecl)
* DTD(REXML::DocType)
* ルート要素
のいずれかです。

• REXML::DocType
• REXML::Document
• REXML::XMLDecl

REXML::Document#add(child) -> () (18337.0)

• 3.2

• インスタンスメソッド

子ノードを追加します。

子ノードを追加します。

追加できるものは
* XML宣言(REXML::XMLDecl)
* DTD(REXML::DocType)
* ルート要素
のいずれかです。

• REXML::DocType
• REXML::Document
• REXML::XMLDecl

REXML::Document#write(output = $stdout, indent = -1, transitive = false, ie_hack = false, encoding=nil) -> () (18337.0)

• 3.2

• インスタンスメソッド

output に XML 文書を出力します。

output に XML 文書を出力します。

XML宣言、DTD、処理命令を(もしあるならば)含む文書を出力します。

注意すべき点として、
元の XML 文書が XML宣言を含んでいなくとも
出力される XML はデフォルトの XML 宣言を含んでいるべきであるが、
REXML は明示しない限り(つまりXML宣言を REXML::Document#add で
追加しない限り)
それをしない、ということである。XML-RPCのような利用法では
ネットワークバンドを少しでも節約する必要があるためである。

2.0.0以降ではキーワード引数による引数指定が可能です。

@param outpu...

• IO
• REXML::Document

REXML::Document#write(output: $stdout, indent: -1, transitive: false, ie_hack: false, encoding: nil) -> () (18337.0)

• 3.2

• インスタンスメソッド

output に XML 文書を出力します。

output に XML 文書を出力します。

XML宣言、DTD、処理命令を(もしあるならば)含む文書を出力します。

注意すべき点として、
元の XML 文書が XML宣言を含んでいなくとも
出力される XML はデフォルトの XML 宣言を含んでいるべきであるが、
REXML は明示しない限り(つまりXML宣言を REXML::Document#add で
追加しない限り)
それをしない、ということである。XML-RPCのような利用法では
ネットワークバンドを少しでも節約する必要があるためである。

2.0.0以降ではキーワード引数による引数指定が可能です。

@param outpu...

• IO
• REXML::Document

絞り込み条件を変える

REXML::Document.parse_stream(source, listener) -> () (18337.0)

• 3.2

• 特異メソッド

XML文書を source から読み込み、パースした結果を listener にコールバックで伝えます。

XML文書を source から読み込み、パースした結果を
listener にコールバックで伝えます。

このメソッドは
Parsers::StreamParser.new( source, listener ).parse
と同じ挙動をします。

コールバックの詳しい仕組みなどについては REXML::Parsers::StreamParser
および REXML::StreamListener を参照してください。

@param source 入力(文字列、IO、IO互換オブジェクト(StringIOなど))
@param listener コールバックオブジェクト

• REXML::Document
• REXML::Parsers::StreamParser
• REXML::StreamListener

REXML::Instruction#content -> String | nil (18337.0)

• 3.2

• インスタンスメソッド

XML 処理命令の内容を返します。

XML 処理命令の内容を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="utf-8" ?>
<?xml-stylesheet type="text/css" href="style.css"?>
<?foobar?>
<root />
EOS
doc[2] # => <?p-i xml-stylesheet ...?>
doc[2].target # => "xml-stylesheet"
doc[2].content...

• REXML::Instruction

REXML::Attribute#namespace(arg = nil) -> String | nil (18319.0)

• 3.2

• インスタンスメソッド

属性の名前空間の URI を返します。

属性の名前空間の URI を返します。

URI が定義されていない場合は nil を返します。

@param arg この値を指定すると、その属性の名前空間でなく、arg という名前空間
の URI が返されます。
通常は省略します。

//emlist[][ruby]{
require 'rexml/document'
e = REXML::Element.new("el")
e.add_attribute("xmlns:ns", "http://www.example.com/ns")
e.add_attribute("ns:r", "rval")
p e....

• REXML::Attribute

REXML::Element#add_namespace(prefix, uri) -> self (18319.0)

• 3.2

• インスタンスメソッド

名前空間を要素に追加します。

名前空間を要素に追加します。

引数が2個の場合は prefix と uri を指定します。
引数が1個の場合はデフォルトの namespace の uri を指定します。

既に同じ prefix が存在する場合はそれが上書きされます。

@param prefix 名前空間の prefix
@param uri 名前空間の uri

//emlist[][ruby]{
require 'rexml/document'
a = REXML::Element.new("a")
a.add_namespace("xmlns:foo", "bar" )
a.add_namespace("foo",...

• REXML::Element

REXML::Element#add_namespace(uri) (18319.0)

• 3.2

• インスタンスメソッド

名前空間を要素に追加します。

名前空間を要素に追加します。

引数が2個の場合は prefix と uri を指定します。
引数が1個の場合はデフォルトの namespace の uri を指定します。

既に同じ prefix が存在する場合はそれが上書きされます。

@param prefix 名前空間の prefix
@param uri 名前空間の uri

//emlist[][ruby]{
require 'rexml/document'
a = REXML::Element.new("a")
a.add_namespace("xmlns:foo", "bar" )
a.add_namespace("foo",...

• REXML::Element

絞り込み条件を変える

REXML::Entity.matches?(string) -> bool (18319.0)

• 3.2

• 特異メソッド

string が実体宣言の文法に従う文字列であれば真を返します。

string が実体宣言の文法に従う文字列であれば真を返します。

@param string 判定対象の文字列

//emlist[][ruby]{
require 'rexml/document'

p REXML::Entity.matches?('<!ENTITY s "seal">') # => true
p REXML::Entity.matches?('<!ENTITY % s "seal">') # => true
p REXML::Entity.matches?('<!ELEMENT br EMPTY >') # => false
//}

• REXML::Entity

Psych::Nodes::Document#root -> Psych::Nodes::Node (18301.0)

• 3.2

• インスタンスメソッド

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

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

• Psych::Nodes::Document

rdoc (18253.0)

• 3.2

• ライブラリ

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ...

• RDoc
• RDoc::Error
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri
• rdoc/ghost_method
• rdoc/include
• rdoc/known_classes
• rdoc/markdown
• ...

rdoc/parser/c (18193.0)

• 3.2

• ライブラリ

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのサブライブラリです。

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析するためのサブライブラリです。

C 言語で記述された拡張ライブラリなどを解析するのに使用します。
rb_define_class や rb_define_method などで定義されたものに
対応する C 言語の関数のコメントを解析します。

例: Array#flatten の場合。rb_ary_flatten のコメントが解析されます。

/*
* Returns a new array that is a one-dimensional flattening of this
* arra...

• RDoc::Parser::C
• e2mmap
• irb/slex
• rdoc
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/ghost_method
• rdoc/include
• rdoc/known_classes
• rdoc/meta_method
• rdoc/normal_class
• rdoc/normal_module
• rdoc/parser
• ...

REXML::DocType (18139.0)

• 3.2

• クラス

XML の DTD(文書型定義、Document Type Definition)を表すクラスです。

XML の DTD(文書型定義、Document Type Definition)を表すクラスです。

rexml では DTD は積極的にはサポートされていません。
デフォルトの実体定義(gt, lt, amp, quot apos)の解決のため DTD は
ある程度はサポートされますが、スキーマの定義や検証をしたい場合は
XML schema や RELAX NG などを使ってください。

子ノード(REXML::Parent#children)として、
* REXML::ElementDecl
* REXML::ExternalEntity
* REXML::Entity
...

• REXML::AttlistDecl
• REXML::ElementDecl
• REXML::Entity
• REXML::ExternalEntity
• REXML::NotationDecl

絞り込み条件を変える

REXML::XMLDecl (18127.0)

• 3.2

• クラス

XML 宣言を表すクラス。

XML 宣言を表すクラス。

文書から XML 宣言を取り出すには REXML::Document#xml_decl を使います。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<e />
EOS

xml_decl = doc.xml_decl
xml_decl.version # => "1.0"
xml_decl.encoding # => "UTF-8"
xml_de...

REXML::NotationDecl (18091.0)

• 3.2

• クラス

DTD の記法宣言を表すクラスです。

DTD の記法宣言を表すクラスです。


//emlist[][ruby]{
require 'rexml/document'

doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE foo [
<!NOTATION type-image-svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!NOTATION type-image-gif PUBLIC "image/gif">...

REXML::Document.entity_expansion_limit -> Integer (18055.0)

• 3.2

• 特異メソッド

実体参照の展開回数の上限を返します。

実体参照の展開回数の上限を返します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10000 です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_limit を使ってください。

@see REXML::Document.entity_expansion_limit=

• REXML::Document

REXML::Document.entity_expansion_limit=(val) (18055.0)

• 3.2

• 特異メソッド

実体参照の展開回数の上限を指定します。

実体参照の展開回数の上限を指定します。

XML 文書(REXML::Document)ごとの展開回数がこの値を越えると
例外を発生させ、処理を中断します。

デフォルトは 10000 です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_limit= を使ってください。

@param val 設定する上限値(整数)
@see REXML::Document.entity_expansion_limit

• REXML::Document

REXML::Document#node_type -> Symbol (18049.0)

• 3.2

• インスタンスメソッド

シンボル :document を返します。

シンボル :document を返します。

• REXML::Document

絞り込み条件を変える

Psych::Nodes::Document#version -> [Integer] (18037.0)

• 3.2

• インスタンスメソッド

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

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

@see Psych::Nodes::Document#version=,
Psych::Nodes::Document.new

• Psych::Nodes::Document

Psych::Nodes::Document#version=(ver) (18037.0)

• 3.2

• インスタンスメソッド

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

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

@param ver 設定するバージョン
@see Psych::Nodes::Document#version,
Psych::Nodes::Document.new

• Psych::Nodes::Document

REXML::Comment (18037.0)

• 3.2

• クラス

XML コメントを表すクラス。

XML コメントを表すクラス。

コメントとは <!-- と --> で挟まれたテキストです。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<!-- xx -->
<root>
<!-- yy -->
text
<!-- zz -->
</root>
EOS

doc[0].string # => " xx "
doc.root[1].string # => " yy "
doc.root[3].string # => " zz "
//}

REXML::Document#stand_alone? -> String (18037.0)

• 3.2

• インスタンスメソッド

XML 宣言の standalone の値を文字列で返します。

XML 宣言の standalone の値を文字列で返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<e />
EOS
doc.stand_alone? # => "yes"
//}

• REXML::Document

REXML::Document#version -> String (18037.0)

• 3.2

• インスタンスメソッド

XML 宣言に含まれている XML 文書のバージョンを返します。

XML 宣言に含まれている XML 文書のバージョンを返します。

文書が XML 宣言を持たない場合はデフォルトの値
(REXML::XMLDecl.defaultで宣言されているもの)を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<e />
EOS
doc.version # => "1.0"
//}

• REXML::Document

絞り込み条件を変える

REXML::Instruction (18037.0)

• 3.2

• クラス

XML 処理命令(XML Processing Instruction, XML PI)を表すクラス。

XML 処理命令(XML Processing Instruction, XML PI)を表すクラス。

XML 処理命令 とは XML 文書中の <? と ?> で挟まれた部分のことで、
アプリケーションへの指示を保持するために使われます。

XML 宣言(文書先頭の <?xml version=... ?>)はXML処理命令ではありませんが、
似た見た目を持っています。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="utf-...

REXML::ParseException (18037.0)

• 3.2

• クラス

XML のパースに失敗したときに生じる例外です。

XML のパースに失敗したときに生じる例外です。

//emlist[][ruby]{
require 'rexml/document'
begin
REXML::Document.new("<a>foo\n</b></a> ")
rescue REXML::ParseException => ex
ex.position # => 16
ex.line # => 2
ex.context # => [16, 2, 2]
end
//}

rdoc/parser/changelog (18037.0)

• 3.2

• ライブラリ

ChangeLog ファイルを解析するためのサブライブラリです。

ChangeLog ファイルを解析するためのサブライブラリです。

ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。

このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。

• RDoc::Parser::ChangeLog
• time

RDoc::RDoc (18019.0)

• 3.2

• クラス

rdoc ドキュメントの作成を行うクラスです。

rdoc ドキュメントの作成を行うクラスです。

以下のようにして、rdoc コマンドを実行するのと同様に実行します。

require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)

args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。

rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。

• rdoc/markup

REXML::Document.entity_expansion_text_limit -> Integer (18019.0)

• 3.2

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_text_limit を使ってください。

@see REXML::Document.entity_expansion_text_limit=,
http://ww...

• REXML::Document

絞り込み条件を変える

REXML::Document.entity_expansion_text_limit=(val) (18019.0)

• 3.2

• 特異メソッド

実体参照の展開による文字列の増分(テキストのバイト数)の 最大値を指定します。

実体参照の展開による文字列の増分(テキストのバイト数)の
最大値を指定します。

展開によって増分値がこの値を越えると
例外を発生させ、処理を中断します。

実体参照の展開処理を使った DoS 攻撃に対抗するための
仕組みです。

デフォルトは 10240 (byte) です。

このメソッドは Ruby 2.1 から deprecated になりました。
REXML::Security.entity_expansion_text_limit= を使ってください。

@see REXML::Document.entity_expansion_text_limit
http://www...

• REXML::Document

REXML::Document#expanded_name -> String (18001.0)

• 3.2

• インスタンスメソッド

""(空文字列)を返します。

""(空文字列)を返します。

XMLの仕様上、このオブジェクトはexpanded name名前を持ちえません。

• REXML::Document

REXML::Document#name -> String (18001.0)

• 3.2

• インスタンスメソッド

""(空文字列)を返します。

""(空文字列)を返します。

XMLの仕様上、このオブジェクトはexpanded name名前を持ちえません。

• REXML::Document

REXML::Document#root -> REXML::Element | nil (18001.0)

• 3.2

• インスタンスメソッド

文書のルート要素を返します。

文書のルート要素を返します。

文書がルート要素を持たない場合は nil を返します。

• REXML::Document

Psych::Visitors::YAMLTree.new(options = {}, emitter = Psych::TreeBuilder.new, ss = Psych::ScalarScanner.new) -> Psych::Visitors::YAMLTree (10009.0)

• 3.2

• 特異メソッド

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

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

options には構築される YAML AST に設定されるオプション設定を指定します。
Psych.dump と同じオプションが指定できます。

emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。

ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner オブジェクトを渡します。

emitter, ss は通常デフォルトのものから変える必要はないでしょう。

@param...

• Psych::ScalarScanner
• Psych::TreeBuilder
• Psych::Visitors::YAMLTree
• String

絞り込み条件を変える

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (9700.0)

• 3.2

• インスタンスメソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

• RDoc::Markdown
• RDoc::Markup::Document

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (9700.0)

• 3.2

• 特異メソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

• RDoc::Markdown
• RDoc::Markup::Document

Psych.parse(yaml, filename = nil) -> Psych::Nodes::Document (9658.0)

• 3.2

• 特異メソッド

YAML ドキュメントをパースし、YAML の AST を返します。

YAML ドキュメントをパースし、YAML の AST を返します。

入力に複数のドキュメントが含まれている場合は、先頭のものを AST に変換して
返します。

filename はパース中に発生した例外のメッセージに用います。

AST については Psych::Nodes を参照してください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたと...

• Psych
• Psych::Nodes
• Psych::SyntaxError

Psych.parse_file(filename) -> Psych::Nodes::Document (9604.0)

• 3.2

• 特異メソッド

filename で指定したファイルをパースして YAML の AST を返します。

filename で指定したファイルをパースして YAML の AST を返します。

@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します

• Psych

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (9604.0)

• 3.2

• インスタンスメソッド

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

@param text 文字列を指定します。

@see RDoc::Text#normalize_comment

• RDoc::Text

絞り込み条件を変える

CSV.new(data, options = Hash.new) -> CSV (9559.0)

• 3.2

• 特異メソッド

このメソッドは CSV ファイルを読み込んだり、書き出したりするために String か IO のインスタンスをラップします。

このメソッドは CSV ファイルを読み込んだり、書き出したりするために
String か IO のインスタンスをラップします。

ラップされた文字列の先頭から読み込むことになります。
文字列に追記したい場合は CSV.generate を使用してください。
他の位置から処理したい場合はあらかじめそのように設定した StringIO を渡してください。

@param data String か IO のインスタンスを指定します。
String のインスタンスを指定した場合、CSV#string を使用して
後からデータを取り出すことが出来ます。...

• ARGF
• CSV
• CSV::Row
• CSV::Table
• IO
• String
• StringIO

リテラル (9433.0)

• 3.2

• 文書

リテラル * num * string * backslash * exp * char * command * here * regexp * array * hash * range * symbol * percent

リテラル
* num
* string
* backslash
* exp
* char
* command
* here
* regexp
* array
* hash
* range
* symbol
* percent

数字の1や文字列"hello world"のようにRubyのプログラムの中に直接
記述できる値の事をリテラルといいます。

===[a:num] 数値リテラル

: 123
: 0d123

整数

: -123

符号つき整数

: 123.45

浮動小数点数。
.1 など "." で始まる浮動小...

• Array
• Hash
• Symbol
• spec/operator
• spec/regexp

REXML::DocType.new(source, parent = nil) -> REXML::DocType (9373.0)

• 3.2

• 特異メソッド

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

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

REXML::Source オブジェクトの場合は、Source オブジェクトが
保持しているDTDのテキストがパースされ、その内容によって DocType
オブジェクトが初期化されます。
REXML::DocType.new(Source.new(<<EOS))
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
EOS
このインターフェースは dep...

• REXML::DocType
• REXML::Source

Kernel#y(*objects) -> nil (9367.0)

• 3.2

• インスタンスメソッド

objects を YAML document として標準出力に出力します。

objects を YAML document として標準出力に出力します。

このメソッドは irb 上でのみ定義されます。

syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてください。

@param objects YAML document に変換する Ruby のオブジェクト

• Kernel
• syck

Psych::Stream#start(encoding = Psych::Nodes::Stream::UTF8) -> Psych::Stream (9367.0)

• 3.2

• インスタンスメソッド

Ruby オブジェクトを YAML document に変換するための準備をします。

Ruby オブジェクトを YAML document に変換するための準備をします。

変換された document は Psych::Stream.new で指定した
出力先に出力されます。

finish を呼び出すことで出力が完了します(finish を呼び出さないと
最後まで出力されない場合があります)。

ブロック付きで start を呼び出すと、変換準備を終えた Stream オブジェクト
(self) がブロックに渡され、ブロックが呼び出された後に finish を呼び出します。
これによって finish を確実に呼び出すことができます。

@param encoding 出...

• Psych::Stream

絞り込み条件を変える

Psych::Stream#start(encoding = Psych::Nodes::Stream::UTF8) {|em| ... } -> Psych::Stream (9367.0)

• 3.2

• インスタンスメソッド

Ruby オブジェクトを YAML document に変換するための準備をします。

Ruby オブジェクトを YAML document に変換するための準備をします。

変換された document は Psych::Stream.new で指定した
出力先に出力されます。

finish を呼び出すことで出力が完了します(finish を呼び出さないと
最後まで出力されない場合があります)。

ブロック付きで start を呼び出すと、変換準備を終えた Stream オブジェクト
(self) がブロックに渡され、ブロックが呼び出された後に finish を呼び出します。
これによって finish を確実に呼び出すことができます。

@param encoding 出...

• Psych::Stream

Psych.parse_stream(yaml) -> Psych::Nodes::Stream (9355.0)

• 3.2

• 特異メソッド

YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。

ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。


@see Psych::Nodes

//emlist[例][ruby]{
Psych.parse_stream("--...

• Psych
• Psych::Nodes
• Psych::Nodes::Stream

REXML::CData.new(text, respect_whitespace = true, parent = nil) -> REXML::CData (9355.0)

• 3.2

• 特異メソッド

text をテキストとして持つ CData オブジェクトを生成します。

text をテキストとして持つ CData オブジェクトを生成します。

respect_whitespace に真を指定すると、text に含まれる空白文字は保存されます。
偽の場合は空白はまとめられます。

@param text テキスト文字列
@param respect_whitespace 空白を保存するかどうかを決める真偽値
@param parent 親ノード

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<root />
EOS
doc.root.add(REXML::...

• REXML::CData

REXML::DocType#write(output, indent = 0, transitive = false, ie_hack = false) -> () (9355.0)

• 3.2

• インスタンスメソッド

output に DTD を出力します。

output に DTD を出力します。

このメソッドは deprecated です。REXML::Formatter で
出力してください。

@param output 出力先の IO オブジェクト
@param indent インデントの深さ。指定しないでください。
@param transitive 無視されます。指定しないでください。
@param ie_hack 無視されます。指定しないでください。

//emlist[][ruby]{
require 'rexml/document'

doctype = REXML::Document.new(<<EOS).doctype
<...

• REXML::DocType
• REXML::Formatter

Psych::Stream.new(io) -> Psych::Stream (9319.0)

• 3.2

• 特異メソッド

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

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

io で YAML document の出力先を指定します。

@param io 出力先の IO オブジェクト

• Psych::Stream

絞り込み条件を変える