検索結果

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

• 2.3.0

• インスタンスメソッド

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

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

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

• REXML::Child
• REXML::Document

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

• 2.3.0

• インスタンスメソッド

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

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

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

• REXML::Document
• REXML::Element

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• RDoc::RDoc

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

• 2.3.0

• インスタンスメソッド

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 (37222.0)

• 2.3.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

• RDoc::CodeObject

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children

• RDoc::CodeObject

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

=== 例

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

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

• Psych::Handler

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

• 2.3.0

• インスタンスメソッド

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

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

• REXML::SAX2Listener

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

• 2.3.0

• インスタンスメソッド

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

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

• REXML::SAX2Listener

Psych.load_documents(yaml) -> [object] (37201.0)

• 2.3.0

• 特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。

複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します

• Psych

絞り込み条件を変える

Psych.load_documents(yaml) {|obj| ... } -> () (37201.0)

• 2.3.0

• 特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。

複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します

• Psych

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

rexml/document (36433.0)

• 2.3.0

• ライブラリ

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
• ...

REXML::DocType#entities -> { String => REXML::Entity } (28819.0)

• 2.3.0

• インスタンスメソッド

DTD で宣言されている実体の集合を Hash で返します。

DTD で宣言されている実体の集合を Hash で返します。

返される Hash は実体参照名をキーとし、対応する REXML::Entity オブジェクト
を値とするハッシュテーブルです。

これには、XML のデフォルトの実体(gt, lt, quot, apos)も含まれています。

//emlist[][ruby]{
doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE foo [
<!ENTITY bar "barbarbarbar">
]>
EOS

p doctype.entities # => { "gt" => #...

• REXML::DocType
• REXML::Entity

REXML::Element#delete_attribute(key) -> REXML::Attribute | nil (28519.0)

• 2.3.0

• インスタンスメソッド

要素から key という属性名の属性を削除します。

要素から key という属性名の属性を削除します。

削除された属性を返します。

key という属性名の属性が存在しない場合は削除されずに、nil を返します。

@param key 削除する要素(文字列(属性名) or REXML::Attributeオブジェクト)

//emlist[][ruby]{
require 'rexml/document'
e = REXML::Element.new("E")
e.add_attribute("x", "foo"); e # => <E x='foo'/>
e.add_attribute("y:x", "bar"); e # => <E x...

• REXML::Attribute
• REXML::Element

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

個々の属性は 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::Document#doctype -> REXML::DocType | nil (28201.0)

• 2.3.0

• インスタンスメソッド

文書の DTD を返します。

文書の DTD を返します。

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

• REXML::Document

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

• 2.3.0

• インスタンスメソッド

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

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

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

• REXML::Document

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

• 2.3.0

• 特異メソッド

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

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

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

実体参照の展開処理を使った 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::Security.entity_expansion_text_limit -> Integer (28009.0)

• 2.3.0

• 特異メソッド

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

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

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

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

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

@see REXML::Document.entity_expansion_text_limit=,
http://www.ruby-lang.org/ja/news/2013/02/22/rexml-dos-2013-02-22/

• REXML::Security

絞り込み条件を変える

REXML::Attributes#get_attribute(name) -> Attribute | nil (27955.0)

• 2.3.0

• インスタンスメソッド

name という名前の属性を取得します。

name という名前の属性を取得します。

name という名前を持つ属性がない場合は nil を返します。

@param name 属性名(文字列)
@see REXML::Attributes#[]

//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='...

• REXML::Attributes

REXML::Attributes#get_attribute_ns(namespace, name) -> REXML::Attribute | nil (27955.0)

• 2.3.0

• インスタンスメソッド

namespace と name で特定される属性を返します。

namespace と name で特定される属性を返します。

namespace で名前空間を、 name で prefix を含まない属性名を
指定します。

指定された属性が存在しない場合は nil を返します。

XML プロセッサが prefix を置き換えてしまった場合でも、このメソッドを
使うことで属性を正しく指定することができます。

@param namespace 名前空間(URI, 文字列)
@param name 属性名(文字列)

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

doc = REXML::Document.ne...

• REXML::Attributes

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

• 2.3.0

• インスタンスメソッド

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#node_type -> Symbol (27949.0)

• 2.3.0

• インスタンスメソッド

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

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

• REXML::Document

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

• 2.3.0

• インスタンスメソッド

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) -> () (27943.0)

• 2.3.0

• インスタンスメソッド

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

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Psych::Nodes::Document

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

• 2.3.0

• インスタンスメソッド

tag directive の配列を返します。

tag directive の配列を返します。

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

• Psych::Nodes::Document

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

• 2.3.0

• 特異メソッド

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

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

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

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

デフォルトは 10000 です。

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

@see REXML::Document.entity_expansion_limit=

• REXML::Document

REXML::Security.entity_expansion_limit -> Integer (27937.0)

• 2.3.0

• 特異メソッド

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

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

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

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

デフォルトは 10000 です。

@see REXML::Document.entity_expansion_limit

• REXML::Document
• REXML::Security

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

• Psych::Nodes::Document

REXML::DocType#entity(name) -> String | nil (27919.0)

• 2.3.0

• インスタンスメソッド

name という実体参照名を持つ実体を文字列で返します。

name という実体参照名を持つ実体を文字列で返します。

返される文字列は非正規化(REXML::Entity#unnormalized 参照)
された文字列が返されます。

name という名前を持つ実体が存在しない場合には nil を返します。

@param name 実体参照名(文字列)

//emlist[][ruby]{
doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE foo [
<!ENTITY bar "barbarbarbar">
]>
EOS
p doctype.entity("bar") # => "ba...

• REXML::DocType

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

• 2.3.0

• インスタンスメソッド

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

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

• Psych::Nodes::Document

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

• 2.3.0

• 特異メソッド

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::Document::DECLARATION -> REXML::XMLDecl (27901.0)

• 2.3.0

• 定数

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

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

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

• REXML::Document

絞り込み条件を変える

REXML::Element#root_node -> REXML::Document | REXML::Node (19348.0)

• 2.3.0

• インスタンスメソッド

self が属する文書のルートノードを返します。

self が属する文書のルートノードを返します。

通常はその要素が属する文書(REXML::Document) オブジェクトが
返されます。

その要素が属する REXML::Document オブジェクトが存在しない
場合は木構造上のルートノードが返されます。

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

children = doc.get_elements...

• REXML::Document
• REXML::Element

REXML::Element#root -> REXML::Element (19309.0)

• 2.3.0

• インスタンスメソッド

self が属する文書のルート要素を返します。

self が属する文書のルート要素を返します。

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

children = doc.get_elements("/root/children").first
children.name # => "children"
children.root.name # => "root"
grandchildren = doc.get...

• REXML::Element

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

• 2.3.0

• 特異メソッド

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::Document.new(source = nil, context = {}) -> REXML::Document (19306.0)

• 2.3.0

• 特異メソッド

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

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

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

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

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

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

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

• 2.3.0

• 特異メソッド

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::Parsers::SAX2Parser#listen(ary, listener) -> () (19273.0)

• 2.3.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Parsers::SAX2Parser#listen(listener) -> () (19273.0)

• 2.3.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Attributes#delete(attribute) -> REXML::Element (19255.0)

• 2.3.0

• インスタンスメソッド

指定した属性を取り除きます。

指定した属性を取り除きます。

attribute で取り除く属性を指定します。
文字列もしくは REXML::Attribute オブジェクトを指定します

self が属する要素(REXML::Element)を返します。

@param attribute 取り除く属性(文字列もしくは REXML::Attribute オブジェクト)

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

doc = REXML::Document.new(<<-EOS)
<root xmlns:foo="http://example.org/foo"
x...

• REXML::Attribute
• REXML::Attributes
• REXML::Element

REXML::Attributes#delete_all(name) -> [REXML::Attribute] (19255.0)

• 2.3.0

• インスタンスメソッド

name という名前を持つ属性をすべて削除します。

name という名前を持つ属性をすべて削除します。

削除された属性を配列で返します。

@param 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 = doc.get_elem...

• REXML::Attributes

REXML::Element#attribute(name, namespace = nil) -> REXML::Attribute | nil (19255.0)

• 2.3.0

• インスタンスメソッド

name で指定される属性を返します。

name で指定される属性を返します。

属性は REXML::Attribute オブジェクトの形で返します。

name は "foo:bar" のように prefix を指定することができます。

namespace で名前空間の URI を指定することで、その名前空間内で
name という属性名を持つ属性を指定できます。

指定した属性名の属性がない場合は nil を返します。

@param name 属性名(文字列)
@param namespace 名前空間のURI(文字列)
//emlist[][ruby]{
require 'rexml/document'

doc = R...

• REXML::Attribute
• REXML::Element

絞り込み条件を変える

REXML::DocType#attribute_of(element, attribute) -> String | nil (19237.0)

• 2.3.0

• インスタンスメソッド

DTD 内の属性リスト宣言で、 element という名前の要素の attribute という 名前の属性のデフォルト値を返します。

DTD 内の属性リスト宣言で、 element という名前の要素の attribute という
名前の属性のデフォルト値を返します。

elementという名前の要素の属性値は宣言されていない、
elementという名前の要素にはattributeという名前の属性が宣言されていない、
もしくはデフォルト値が宣言されていない、のいずれかの場合は nil を返します。

@param element 要素名(文字列)
@param attribute 属性名(文字列)

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

doctype = REXML::Doc...

• REXML::DocType

REXML::DocType#attributes_of(element) -> [REXML::Attribute] (19237.0)

• 2.3.0

• インスタンスメソッド

DTD 内の属性リスト宣言で、 element という名前の要素に対し宣言されている 属性の名前とデフォルト値を REXML::Attribute の配列で返します。

DTD 内の属性リスト宣言で、 element という名前の要素に対し宣言されている
属性の名前とデフォルト値を REXML::Attribute の配列で返します。

名前とデフォルト値のペアは、各 Attribute オブジェクトの
REXML::Attribute#name と
REXML::Attribute#value で表現されます。

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

doctype = REXML::Document.new(<<EOS).doctype
<!DOCTYPE books [
<!ELEMENT book (c...

• REXML::DocType

REXML::Element#add_attribute(attr) -> () (19237.0)

• 2.3.0

• インスタンスメソッド

要素の属性を追加します。 同じ名前の属性がすでにある場合はその属性を新しい 属性で置き換えます。

要素の属性を追加します。
同じ名前の属性がすでにある場合はその属性を新しい
属性で置き換えます。

引数の与えかたは2通りあります。
要素名と値の2つの文字列で渡す方法と REXML::Attribute オブジェクトを
渡す方法です。

文字列2つで指定する場合、属性値は unnormalized な文字列を渡す必要があります。

@param key 属性名(文字列)
@param value 属性値(文字列)
@param attr 属性(REXML::Attribute オブジェクト)

//emlist[][ruby]{
require 'rexml/document'
doc = ...

• REXML::Attribute
• REXML::Element

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

• 2.3.0

• インスタンスメソッド

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

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

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

@see REXML::DocType

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

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

• 2.3.0

• インスタンスメソッド

self を複製します。

self を複製します。

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

• REXML::Document

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

• REXML::DocType
• REXML::Document

REXML::Element#add_attributes(attrs) -> () (19219.0)

• 2.3.0

• インスタンスメソッド

要素の属性を複数追加します。 同じ名前の属性がすでにある場合はその属性を新しい 属性で置き換えます。

要素の属性を複数追加します。
同じ名前の属性がすでにある場合はその属性を新しい
属性で置き換えます。

attrs には Hash もしくは Array を指定できます。
Hash の場合は、
{ "name1" => "value1", "name2" => "value2", ... }
という形で、配列の場合は
[ ["name1", "value1"], ["name2", "value2"], ... }
という形で追加/更新する属性を指定します。

@param attrs 追加する属性の属性名と属性値の対の集合(Array or Hash)

//emlist[][rub...

• Array
• Hash
• REXML::Element

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

• 2.3.0

• 定数

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

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

• RDoc

REXML::Element#add_element(element, attrs = nil) -> Element (19153.0)

• 2.3.0

• インスタンスメソッド

子要素を追加します。

子要素を追加します。

element として追加する要素を指定します。
REXML::Element オブジェクトもしくは文字列を指定します。

element として REXML::Element オブジェクトを指定した場合、それが追加されます。
文字列を指定した場合は、それを要素名とする要素を追加します。

attrs に { String => String } という Hash を渡すと、
追加する要素の属性を指定できます。

子要素の最後に追加されます。

返り値は追加された要素です。

@param element 追加する要素
@param attrs 追加する要素に設定する...

• REXML::Element

REXML::XPath.first(element, path = nil, namespaces = {}, variables = {}) -> Node | nil (19135.0)

• 2.3.0

• 特異メソッド

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

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

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

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

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

...

• REXML::Element
• REXML::XPath

絞り込み条件を変える

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

• 2.3.0

• 特異メソッド

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_text(text = nil, max = 0, name = nil) {|element| ... } -> () (19117.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

...

• REXML::Element

REXML::Element#xpath -> String (19027.0)

• 2.3.0

• インスタンスメソッド

文書上の対象の要素にのみマッチする xpath 文字列を返します。

文書上の対象の要素にのみマッチする xpath 文字列を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new('<a><b/><c/></a>')
c = doc.root.elements[2] # <a> .. </a> の中の <c/> 要素
c # => <c/>
c.xpath # => "/a/c"
doc = REXML::Document.new('<a><b/><b/></a>')
b = doc.root.elements[2] # <a> .. </a> の中の2番目の <b...

• REXML::Element

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

• 2.3.0

• インスタンスメソッド

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::Instruction#target -> String (19027.0)

• 2.3.0

• インスタンスメソッド

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"?>
<root />
EOS
doc[2] # => <?p-i xml-stylesheet ...?>
doc[2].target # => "xml-stylesheet"
doc[2].content # => "t...

• REXML::Instruction

絞り込み条件を変える

REXML::Element#get_text(path = nil) -> REXML::Text | nil (19009.0)

• 2.3.0

• インスタンスメソッド

先頭のテキスト子ノードを返します。

先頭のテキスト子ノードを返します。

raw モードの設定は無視され、常に正規化されたテキストを返します。
REXML::Text#value も参照してください。

path を渡した場合は、その XPath 文字列で指定される
テキストノードの文字列を返します。

テキストノードがない場合には nil を返します。

@param path XPath文字列
@see REXML::Element#text

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new "<p>some text <b>this ...

• REXML::Element

REXML::Element#text(path = nil) -> String | nil (19009.0)

• 2.3.0

• インスタンスメソッド

先頭のテキスト子ノードの文字列を返します。

先頭のテキスト子ノードの文字列を返します。

テキストノードを複数保持している場合は最初のノードにしか
アクセスできないことに注意してください。

raw モードの設定は無視され、常に正規化されたテキストを返します。
REXML::Text#value も参照してください。

path を渡した場合は、その XPath 文字列で指定される
テキストノードの文字列を返します。

テキストノードがない場合には nil を返します。

@param path XPath文字列
@see REXML::Element#get_text

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

• REXML::Element

JSON::State#generate(obj) -> String (18997.0)

• 2.3.0

• インスタンスメソッド

Generates a valid JSON document from object obj and returns the result. If no valid JSON document can be created this method raises a GeneratorError exception.

Generates a valid JSON document from object obj and returns the
result. If no valid JSON document can be created this method raises a
GeneratorError exception.

• JSON::State

REXML::DocType#system -> String | nil (18991.0)

• 2.3.0

• インスタンスメソッド

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://www.w...

• REXML::DocType

Psych.parse_stream(yaml) {|node| ... } -> () (18973.0)

• 2.3.0

• 特異メソッド

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::DocType#external_id -> String | nil (18973.0)

• 2.3.0

• インスタンスメソッド

DTD が外部サブセットを用いている場合は "SYSTEM", "PUBLIC" の いずれかの文字列を返します。

DTD が外部サブセットを用いている場合は "SYSTEM", "PUBLIC" の
いずれかの文字列を返します。

それ以外の場合は 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....

• REXML::DocType

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

• 2.3.0

• インスタンスメソッド

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

REXML::Parsers::SAX2Parser#listen(ary) { ... } -> () (18973.0)

• 2.3.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Parsers::SAX2Parser#listen(sym) { ... } -> () (18973.0)

• 2.3.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Parsers::SAX2Parser#listen(sym, ary) { ... } -> () (18973.0)

• 2.3.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

絞り込み条件を変える

REXML::Text#to_s -> String (18973.0)

• 2.3.0

• インスタンスメソッド

テキストの内容を正規化(すべての実体をエスケープ)された状態で返します。

テキストの内容を正規化(すべての実体をエスケープ)された状態で返します。

つまり返り値は XML のテキストとして妥当です。

結果は REXML::Text.new で指定した entity_filter を反映しています。

@see REXML::Text#value

//emlist[][ruby]{
require 'rexml/document'
t = REXML::Text.new("< & foobar", false, nil, false)
t.to_s # => "&lt; &amp; foobar"
t.value # => "< & foobar"
//}

• REXML::Text

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

• 2.3.0

• インスタンスメソッド

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 (18967.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

@param encoding 出...

• Psych::Stream

REXML::Attributes#length -> Integer (18955.0)

• 2.3.0

• インスタンスメソッド

属性の個数を返します。

属性の個数を返します。


//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/a").first

p a.attributes.length # => 3
//}
...

• REXML::Attributes

REXML::CData#to_s -> String (18955.0)

• 2.3.0

• インスタンスメソッド

テキスト文字列を返します。

テキスト文字列を返します。

@see REXML::Text#value, REXML::Text#to_s

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<root><![CDATA[foobar baz]]></root>
EOS
doc.root[0].class # => REXML::CData
doc.root[0].value # => "foobar baz"
//}

• REXML::CData

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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::Element#delete_element(element) -> REXML::Element (18955.0)

• 2.3.0

• インスタンスメソッド

子要素を削除します。

子要素を削除します。

element で削除する要素を指定できます。整数、文字列、REXML::Element
オブジェクトのいずれかが指定できます。

REXML::Element を指定すると、その要素が削除されます。
整数を指定すると、element 番目の要素を削除します(1-originで指定します)。
文字列を指定すると、XPath としてマッチする要素を削除します。
複数の要素がマッチする場合はそのうち1つが削除されます。

@param element 削除する要素
@see REXML::Elements#delete

//emlist[][ruby]{
require...

• REXML::Element

REXML::Element#has_elements? -> bool (18955.0)

• 2.3.0

• インスタンスメソッド

self が一つでも子要素を持つならば true を返します。

self が一つでも子要素を持つならば true を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new("<a><b/><c>Text</c></a>")
doc.root.has_elements? # => true
doc.elements["/a/b"].has_elements? # => false
# /a/c はテキストノードしか持たないので false である
doc.elements["/a/c"].has_elements? # => f...

• REXML::Element

REXML::Elements#delete(element) -> Element (18955.0)

• 2.3.0

• インスタンスメソッド

element で指定した子要素を取り除きます。

element で指定した子要素を取り除きます。

element には、REXML::Element、整数、文字列が指定できます。
Element オブジェクトを指定した場合は、その子要素を取り除きます。
整数を指定した場合には element 番目の子要素を削除します(1-originです)。
文字列を指定した場合は、削除する要素を XPath で指定します。
XPathが複数の要素を指している場合は、そのうち一つを削除します。

取り除かれた要素を返します。

XPath で指定した場合、子要素ではない要素も取り除けることに注意してください。

@param element 削除する要素...

• REXML::Element
• REXML::Elements

REXML::Elements#to_a(xpath = nil) -> [REXML::Element] (18955.0)

• 2.3.0

• インスタンスメソッド

すべての子要素の配列を返します。

すべての子要素の配列を返します。

xpath を指定した場合は、その XPath 文字列に
マッチする要素の配列を返します。

REXML::Elements#each と同様、REXML::XPath.match などと
異なり、要素以外の子ノードは無視されます。

@param xpath XPath文字列

//emlist[][ruby]{
require 'rexml/document'
require 'rexml/xpath'
doc = REXML::Document.new '<a>sean<b/>elliott<c/></a>'
doc.root.elements.to_...

• REXML::Elements
• REXML::XPath.match

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

オブジェクトを 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

Object#to_yaml(options = {}) -> String (18949.0)

• 2.3.0

• インスタンスメソッド

オブジェクトを 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_methods_etc -> () (18949.0)

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

REXML::XMLDecl#dowrite -> () (18949.0)

• 2.3.0

• インスタンスメソッド

出力時(REXML::Document#write) に XML 宣言を省略しない よう指示します。

出力時(REXML::Document#write) に XML 宣言を省略しない
よう指示します。

@see REXML::XMLDecl#nowrite, REXML::XMLDecl#writethis

• REXML::XMLDecl

REXML::XMLDecl#nowrite -> () (18949.0)

• 2.3.0

• インスタンスメソッド

出力時(REXML::Document#write) に XML 宣言を省略する よう指示します。

出力時(REXML::Document#write) に XML 宣言を省略する
よう指示します。

@see REXML::XMLDecl#dowrite, REXML::XMLDecl#writethis

• REXML::XMLDecl

絞り込み条件を変える

REXML::XMLDecl#writethis -> bool (18949.0)

• 2.3.0

• インスタンスメソッド

出力時(REXML::Document#write) に XML 宣言を出力する(省略しない) ならば真を返します。

出力時(REXML::Document#write) に XML 宣言を出力する(省略しない)
ならば真を返します。

@see REXML::XMLDecl#dowrite, REXML::XMLDecl#nowrite

• REXML::XMLDecl

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Psych::Nodes::Document

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

• 2.3.0

• インスタンスメソッド

以降に解析したコメントを 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 -> () (18937.0)

• 2.3.0

• インスタンスメソッド

以降に解析したコメントを 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#to_a -> [Attribute] (18937.0)

• 2.3.0

• インスタンスメソッド

属性の配列を返します。

属性の配列を返します。

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

• REXML::Attributes

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

REXML::Element#add_attribute(key, value) -> () (18937.0)

• 2.3.0

• インスタンスメソッド

要素の属性を追加します。 同じ名前の属性がすでにある場合はその属性を新しい 属性で置き換えます。

要素の属性を追加します。
同じ名前の属性がすでにある場合はその属性を新しい
属性で置き換えます。

引数の与えかたは2通りあります。
要素名と値の2つの文字列で渡す方法と REXML::Attribute オブジェクトを
渡す方法です。

文字列2つで指定する場合、属性値は unnormalized な文字列を渡す必要があります。

@param key 属性名(文字列)
@param value 属性値(文字列)
@param attr 属性(REXML::Attribute オブジェクト)

//emlist[][ruby]{
require 'rexml/document'
doc = ...

• REXML::Attribute
• REXML::Element

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

@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

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• REXML::Element

REXML::Element#next_element -> Element | nil (18937.0)

• 2.3.0

• インスタンスメソッド

次の兄弟要素を返します。

次の兄弟要素を返します。

次の要素が存在しない場合は nil を返します。

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new '<a><b/>text<c/></a>'
doc.root.elements['b'].next_element # => <c/>
doc.root.elements['c'].next_element # => nil
//}

• REXML::Element

絞り込み条件を変える

REXML::Elements#delete_all(xpath) -> [REXML::Element] (18937.0)

• 2.3.0

• インスタンスメソッド

xpath で指定した XPath 文字列にマッチする要素をすべて取り除きます。

xpath で指定した XPath 文字列にマッチする要素をすべて取り除きます。

@param xpath 取り除く要素を指し示す XPath 文字列

//emlist[][ruby]{
require 'rexml/document'
doc = REXML::Document.new('<a><c/><c/><c/><c/></a>')
doc.elements.delete_all("a/c") # => [<c/>, <c/>, <c/>, <c/>]
doc.to_s # => "<a/>"
//}

• REXML::Elements

Psych::Nodes::Node#to_yaml(io=nil, options={}) -> String | IO (18919.0)

• 2.3.0

• インスタンスメソッド

AST を YAML ドキュメントに変換します。

AST を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。

io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。

Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。

options には以下が指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文...

• IO
• Psych::Nodes::Node
• Psych::Nodes::Stream

REXML::Attribute#to_string -> String (18919.0)

• 2.3.0

• インスタンスメソッド

"name='value'" という形式の文字列を返します。

"name='value'" という形式の文字列を返します。

//emlist[][ruby]{
require 'rexml/document'
e = REXML::Element.new("el")
e.add_attribute("ns:r", "rval")
p e.attributes.get_attribute("r").to_string # => "ns:r='rval'"
//}

• REXML::Attribute

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

• 2.3.0

• 特異メソッド

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

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

• 2.3.0

• インスタンスメソッド

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

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

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

• REXML::Document

絞り込み条件を変える